Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Private Types | Private Attributes | List of all members
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 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...
 
 Direction (const Direction &d)
 copy constructor More...
 
int getToward () const
 get the toward index More...
 
bool isToward () const
 true only if the direction is set by a toward atom More...
 
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...
 

Private Types

enum  DirState { NOT_SPECIFIED, NULL_DIR, SPECIFIED, TOWARD }
 state of the x,y and z More...
 

Private Attributes

int towardIndex
 toward atom index More...
 
double x
 x coordinates More...
 
DirState xState
 state for the x coordinates More...
 
double y
 y coordinates More...
 
DirState yState
 state for the y coordinates More...
 
double z
 z coordinates More...
 
DirState zState
 state for the z coordinates More...
 

Detailed Description

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

Constructor & Destructor Documentation

Direction::Direction ( )
inline

default constructor: nothing is specified

Direction::Direction ( const unsigned int  toward)
inline

constructor with initialization of the toward

References setToward().

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

constructor with initialization of the 3 directions

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

Direction::Direction ( const Direction d)
inline

copy constructor

References towardIndex, x, xState, y, yState, z, and zState.

Member Function Documentation

int Direction::getToward ( ) const
inline

get the toward index

References towardIndex.

double Direction::getX ( ) const
inline

get the x coordinate

References x.

double Direction::getY ( ) const
inline

get the y coordinate

double Direction::getZ ( ) const
inline

get the z coordinate

bool Direction::isToward ( ) const
inline

true only if the direction is set by a toward atom

References TOWARD, towardIndex, xState, yState, and zState.

Referenced by xmlPrint().

bool Direction::isXNull ( ) const
inline

is the x coordinate NULL ?

References NULL_DIR, and xState.

bool Direction::isXSpecified ( ) const
inline

is the x coordinate specified

References SPECIFIED, and xState.

bool Direction::isYNull ( ) const
inline

is the y coordinate NULL ?

References NULL_DIR, and yState.

bool Direction::isYSpecified ( ) const
inline

is the y coordinate specified

References SPECIFIED, and yState.

bool Direction::isZNull ( ) const
inline

is the z coordinate NULL ?

References NULL_DIR, and zState.

bool Direction::isZSpecified ( ) const
inline

is the z coordinate specified

References SPECIFIED, and zState.

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

set the direction

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

void Direction::setNullX ( )
inline

set the x coordinate as NULL

References NULL_DIR, x, and xState.

void Direction::setNullY ( )
inline

set the y coordinate as NULL

References NULL_DIR, y, and yState.

void Direction::setNullZ ( )
inline

set the z coordinate as NULL

References NULL_DIR, z, and zState.

void Direction::setToward ( const unsigned int  toward)
inline

set the toward index

References TOWARD, towardIndex, xState, yState, and zState.

Referenced by Direction().

void Direction::setX ( const double  x)
inline

set the x coordinate

References SPECIFIED, x, and xState.

Referenced by Direction(), and set().

void Direction::setY ( const double  y)
inline

set the y coordinate

References SPECIFIED, y, and yState.

Referenced by Direction(), and set().

void Direction::setZ ( const double  z)
inline

set the z coordinate

References SPECIFIED, z, and zState.

Referenced by Direction(), and set().

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

print to an ostream

References isToward(), NOT_SPECIFIED, NULL_DIR, SPECIFIED, towardIndex, x, xState, y, yState, z, and zState.

Member Data Documentation

int Direction::towardIndex
private

toward atom index

Referenced by Direction(), getToward(), isToward(), setToward(), and xmlPrint().

double Direction::x
private

x coordinates

Referenced by Direction(), getX(), setNullX(), setX(), and xmlPrint().

DirState Direction::xState
private

state for the x coordinates

Referenced by Direction(), isToward(), isXNull(), isXSpecified(), setNullX(), setToward(), setX(), and xmlPrint().

double Direction::y
private

y coordinates

Referenced by Direction(), setNullY(), setY(), and xmlPrint().

DirState Direction::yState
private

state for the y coordinates

Referenced by Direction(), isToward(), isYNull(), isYSpecified(), setNullY(), setToward(), setY(), and xmlPrint().

double Direction::z
private

z coordinates

Referenced by Direction(), setNullZ(), setZ(), and xmlPrint().

DirState Direction::zState
private

state for the z coordinates

Referenced by Direction(), isToward(), isZNull(), isZSpecified(), setNullZ(), setToward(), setZ(), and xmlPrint().


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