The Boundary class is an object representing a Particle's endpoints. More...

#include <boundary.h>

Public Member Functions
	Boundary (int dimensionIn, double valueIn, bool isUpper, BoundingBox *boxIn)
	Constructs a Boundary Object. More...

double	getValue ()
	Returns the coordinate of this Boundary. More...

bool	isUpper ()
	Returns whether or not this is an upper bound of a BoundingBox. More...

bool	isLower ()
	Returns whether or not this is a lower bound of a BoundingBox. More...

int	getDimension ()
	Returns the dimension this Boundary is bounding. More...

BoundingBox *	getBox ()
	Returns a pointer to the BoundingBox this Boundary relates to. More...

void	update ()
	Adjusts the coordinte value of this Bounary to reflect the current location of its associated BoundingBox.

Detailed Description

The Boundary class is an object representing a Particle's endpoints.

Constructor & Destructor Documentation

Boundary::Boundary	(	int	dimensionIn,
		double	valueIn,
		bool	isUpper,
		BoundingBox *	boxIn
	)

Constructs a Boundary Object.

Constructs a Boundary Object representing a side or face of a bouning box. Initializes the dimension the Boundary is in, the location of the Boundary, whether it is an upper or lower bound, and the BoundingBox that this Boundary of the end of.

Parameters

dimensionIn	either X_DIMENSION, Y_DIMENSION, or Z_DIMENSION.
valueIn	the location of this Boundary in the dimension.
isUpper	true if this represents the max of a BoundingBox in the dimension.
boxIn	the BoundingBox we are representing a border of.

Member Function Documentation

BoundingBox * Boundary::getBox ( )

Returns a pointer to the BoundingBox this Boundary relates to.

Returns: The associated BoundingBox.

int Boundary::getDimension ( )

Returns the dimension this Boundary is bounding.

Returns: Either X_DIMENSION, Y_DIMENSION, or Z_DIMENSION.

double Boundary::getValue ( )

Returns the coordinate of this Boundary.

Returns: The coordinate of this Boundary.

bool Boundary::isLower ( )

Returns whether or not this is a lower bound of a BoundingBox.

Returns: True if it is a lower bound, False if not.

bool Boundary::isUpper ( )

Returns whether or not this is an upper bound of a BoundingBox.

Returns: True if it is an upper bound, False if not.

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

src/boundary.h
src/boundary.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation