Rectangle Class Reference

Specify a rectangular region in the Y-Z plane. More...

#include <Rectangle.hpp>

Inheritance diagram for Rectangle:

Public Member Functions
	Rectangle ()
	Rectangle (const double y, const double z, const double b, const double c)
	Takes two points to specify the rectangle.
	Rectangle (const CartPosition &lower, const CartPosition &upper)
	Rectangle (const Rectangle &the_rectangle)
CartPosition	getUpper () const
	Get the [max(y) max(z)] corner of the rectangle.
CartPosition	getLower () const
	Get the [min(y) min(z)] corner of the rectangle.
double	getXLength () const
double	getYLength () const
double	getZLength () const
double	getLargestLength () const
unsigned	getType () const
std::vector< unsigned >	getDimension (const Grid &grid) const
Rectangle *	clone () const
std::vector< std::vector < unsigned > >	getCoordinateIndex (const Grid &grid) const
	~Rectangle ()
Public Member Functions inherited from Shape
virtual	~Shape ()
	The destructor cannot be pure virtual.

Public Attributes
CartPosition	lower
CartPosition	upper

Detailed Description

Specify a rectangular region in the Y-Z plane.

Constructor & Destructor Documentation

Rectangle::Rectangle

(

)

Rectangle::Rectangle	(	const double	y,
		const double	z,
		const double	b,
		const double	c
	)

Takes two points to specify the rectangle.

Identify the lower and upper points given the coordinate of the input points.

Rectangle::Rectangle	(	const CartPosition &	lower,
		const CartPosition &	upper
	)

Rectangle::Rectangle

(

const Rectangle &

the_rectangle

)

Rectangle::~Rectangle

(

)

Member Function Documentation

Rectangle * Rectangle::clone ( ) const

virtual

Implements Shape.

std::vector< std::vector< unsigned > > Rectangle::getCoordinateIndex ( const Grid &  grid ) const

virtual

Implements Shape.

std::vector<unsigned> Rectangle::getDimension

(

const Grid &

grid

)

const

double Rectangle::getLargestLength ( ) const

virtual

Implements Shape.

CartPosition Rectangle::getLower ( ) const

virtual

Get the [min(y) min(z)] corner of the rectangle.

Returns

the cartesian coordinate the conner.

Implements Shape.

unsigned Rectangle::getType ( ) const

virtual

Implements Shape.

CartPosition Rectangle::getUpper ( ) const

virtual

Get the [max(y) max(z)] corner of the rectangle.

Returns

the cartesian coordinate the conner.

Implements Shape.

double Rectangle::getXLength ( ) const

virtual

Implements Shape.

double Rectangle::getYLength ( ) const

virtual

Implements Shape.

double Rectangle::getZLength ( ) const

virtual

Implements Shape.

Member Data Documentation

CartPosition Rectangle::lower

CartPosition Rectangle::upper

---

The documentation for this class was generated from the following files:

• include/Rectangle.hpp
• src/Rectangle.cpp