Circle Class Reference

#include <Circle.hpp>

Inheritance diagram for Circle:

Public Member Functions
	Circle ()
	Circle (const CartPosition &p, const double r)
	Circle (const Circle &the_circle)
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
double	getRadius () const
CartPosition	getCenter () const
unsigned	getType () const
std::vector< unsigned >	getDimension (const Grid &grid) const
Circle *	clone () const
std::vector< std::vector < unsigned > >	getCoordinateIndex (const Grid &grid) const
	~Circle ()
Public Member Functions inherited from Shape
virtual	~Shape ()
	The destructor cannot be pure virtual.

Private Attributes
CartPosition	lower
CartPosition	upper

Constructor & Destructor Documentation

Circle::Circle ( )

inline

Circle::Circle	(	const CartPosition &	p,
		const double	r
	)

Parameters

&p	the center location
r	radius must be greater than 0

Circle::Circle

(

const Circle &

the_circle

)

Circle::~Circle ( )

inline

Member Function Documentation

Circle* Circle::clone ( ) const

inlinevirtual

Implements Shape.

CartPosition Circle::getCenter ( ) const

inline

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

virtual

Implements Shape.

std::vector<unsigned> Circle::getDimension

(

const Grid &

grid

)

const

double Circle::getLargestLength ( ) const

inlinevirtual

Implements Shape.

CartPosition Circle::getLower ( ) const

inlinevirtual

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

Returns

the cartesian coordinate the conner.

Implements Shape.

double Circle::getRadius ( ) const

inline

unsigned Circle::getType ( ) const

inlinevirtual

Implements Shape.

CartPosition Circle::getUpper ( ) const

inlinevirtual

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

Returns

the cartesian coordinate the conner.

Implements Shape.

double Circle::getXLength ( ) const

inlinevirtual

Implements Shape.

double Circle::getYLength ( ) const

inlinevirtual

Implements Shape.

double Circle::getZLength ( ) const

inlinevirtual

Implements Shape.

Member Data Documentation

CartPosition Circle::lower

private

CartPosition Circle::upper

private

---

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

• include/Circle.hpp
• src/Circle.cpp