Direction Class Reference

Class that defines the direction of the Load with x, y and z. More...

#include <Direction.h>

Public Member Functions
	Direction ()
	default constructor: nothing is specified
	Direction (const Direction &d)
	copy constructor
	Direction (const unsigned int toward)
	constructor with initialization of the toward
	Direction (double x0, double y0, double z0)
	constructor with initialization of the 3 directions
int	getToward () const
	get the toward index
bool	isToward () const
	true only if the direction is set by a toward atom
Direction &	operator= (const Direction &d)
void	set (const double x, const double y, const double z)
	set the direction
void	setToward (const unsigned int toward)
	set the toward index
void	xmlPrint (std::ostream &o) const
	print to an ostream
X direction
double	getX () const
	get the x coordinate
bool	isXNull () const
	is the x coordinate NULL ?
bool	isXSpecified () const
	is the x coordinate specified
void	setNullX ()
	set the x coordinate as NULL
void	setX (const double x)
	set the x coordinate
Y direction
double	getY () const
	get the y coordinate
bool	isYNull () const
	is the y coordinate NULL ?
bool	isYSpecified () const
	is the y coordinate specified
void	setNullY ()
	set the y coordinate as NULL
void	setY (const double y)
	set the y coordinate

Z direction
double	getZ () const
	get the z coordinate
bool	isZNull () const
	is the z coordinate NULL ?
bool	isZSpecified () const
	is the z coordinate specified
void	setNullZ ()
	set the z coordinate as NULL
void	setZ (const double z)
	set the z coordinate

Detailed Description

Class that defines the direction of the Load with x, y and z.

Constructor & Destructor Documentation

Direction() [1/4]

Direction::Direction ( )

inline

default constructor: nothing is specified

Referenced by Direction(), and operator=().

Direction() [2/4]

Direction::Direction ( const unsigned int toward )

inline

constructor with initialization of the toward

References setToward().

Direction() [3/4]

Direction::Direction ( double x0, double y0, double z0 )

inline

constructor with initialization of the 3 directions

References setX(), setY(), and setZ().

Direction() [4/4]

Direction::Direction ( const Direction & d )

inline

copy constructor

References Direction().

Member Function Documentation

getToward()

int Direction::getToward ( ) const

inline

get the toward index

getX()

double Direction::getX ( ) const

inline

get the x coordinate

getY()

double Direction::getY ( ) const

inline

get the y coordinate

getZ()

double Direction::getZ ( ) const

inline

get the z coordinate

isToward()

bool Direction::isToward ( ) const

inline

true only if the direction is set by a toward atom

Referenced by xmlPrint().

isXNull()

bool Direction::isXNull ( ) const

inline

is the x coordinate NULL ?

isXSpecified()

bool Direction::isXSpecified ( ) const

inline

is the x coordinate specified

isYNull()

bool Direction::isYNull ( ) const

inline

is the y coordinate NULL ?

isYSpecified()

bool Direction::isYSpecified ( ) const

inline

is the y coordinate specified

isZNull()

bool Direction::isZNull ( ) const

inline

is the z coordinate NULL ?

isZSpecified()

bool Direction::isZSpecified ( ) const

inline

is the z coordinate specified

operator=()

Direction & Direction::operator= ( const Direction & d )

inline

References Direction().

set()

void Direction::set ( const double x, const double y, const double z )

inline

set the direction

References setX(), setY(), and setZ().

setNullX()

void Direction::setNullX ( )

inline

set the x coordinate as NULL

setNullY()

void Direction::setNullY ( )

inline

set the y coordinate as NULL

setNullZ()

void Direction::setNullZ ( )

inline

set the z coordinate as NULL

setToward()

void Direction::setToward ( const unsigned int toward )

inline

set the toward index

Referenced by Direction(), and Loads::xmlRead().

setX()

void Direction::setX ( const double x )

inline

set the x coordinate

Referenced by Direction(), set(), and Loads::xmlRead().

setY()

void Direction::setY ( const double y )

inline

set the y coordinate

Referenced by Direction(), set(), and Loads::xmlRead().

setZ()

void Direction::setZ ( const double z )

inline

set the z coordinate

Referenced by Direction(), set(), and Loads::xmlRead().

xmlPrint()

void Direction::xmlPrint ( std::ostream & o ) const

inline

print to an ostream

References isToward().

---

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

• Direction.h