Computer Assisted Medical Intervention Tool Kit  version 5.2
Direction Class Reference

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

#include <Direction.h>

+ Collaboration diagram for Direction:

Public Member Functions

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

Z direction

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

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

◆ Direction() [2/4]

Direction::Direction ( const unsigned int  toward)
inline

constructor with initialization of the toward

References setToward().

+ Here is the call graph for this function:

◆ Direction() [3/4]

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

constructor with initialization of the 3 directions

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

+ Here is the call graph for this function:

◆ Direction() [4/4]

Direction::Direction ( const Direction d)
inline

copy constructor

Member Function Documentation

◆ getToward()

int Direction::getToward ( ) const
inline

get the toward index

◆ getX()

double Direction::getX ( ) const
inline

get the x coordinate

Referenced by Translation::ansysPrint(), and Load::getDirection().

+ Here is the caller graph for this function:

◆ getY()

double Direction::getY ( ) const
inline

get the y coordinate

Referenced by Translation::ansysPrint(), and Load::getDirection().

+ Here is the caller graph for this function:

◆ getZ()

double Direction::getZ ( ) const
inline

get the z coordinate

Referenced by Translation::ansysPrint(), and Load::getDirection().

+ Here is the caller graph for this function:

◆ isToward()

bool Direction::isToward ( ) const
inline

true only if the direction is set by a toward atom

Referenced by xmlPrint().

+ Here is the caller graph for this function:

◆ isXNull()

bool Direction::isXNull ( ) const
inline

is the x coordinate NULL ?

Referenced by Translation::ansysPrint().

+ Here is the caller graph for this function:

◆ isXSpecified()

bool Direction::isXSpecified ( ) const
inline

is the x coordinate specified

◆ isYNull()

bool Direction::isYNull ( ) const
inline

is the y coordinate NULL ?

Referenced by Translation::ansysPrint().

+ Here is the caller graph for this function:

◆ isYSpecified()

bool Direction::isYSpecified ( ) const
inline

is the y coordinate specified

◆ isZNull()

bool Direction::isZNull ( ) const
inline

is the z coordinate NULL ?

Referenced by Translation::ansysPrint().

+ Here is the caller graph for this function:

◆ isZSpecified()

bool Direction::isZSpecified ( ) const
inline

is the z coordinate specified

◆ operator=()

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

◆ set()

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

set the direction

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

Referenced by Load::setDirection().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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().

+ Here is the caller graph for this function:

◆ setX()

void Direction::setX ( const double  x)
inline

set the x coordinate

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

+ Here is the caller graph for this function:

◆ setY()

void Direction::setY ( const double  y)
inline

set the y coordinate

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

+ Here is the caller graph for this function:

◆ setZ()

void Direction::setZ ( const double  z)
inline

set the z coordinate

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

+ Here is the caller graph for this function:

◆ xmlPrint()

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

print to an ostream

References isToward().

Referenced by Load::xmlPrint().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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