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 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...

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
enum	DirState { NOT_SPECIFIED, NULL_DIR, SPECIFIED, TOWARD }
	state of the x,y and z More...

double	x {0.0}
	x coordinates More...

double	y {0.0}
	y coordinates More...

double	z {0.0}
	z coordinates More...

DirState	xState {NOT_SPECIFIED}
	state for the x coordinates More...

DirState	yState {NOT_SPECIFIED}
	state for the y coordinates More...

DirState	zState {NOT_SPECIFIED}
	state for the z coordinates More...

int	towardIndex {-1}
	toward atom index More...

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.

Member Enumeration Documentation

◆ DirState

enum Direction::DirState

private

state of the x,y and z

Enumerator
NOT_SPECIFIED	the direction has never been specified: it is absolutly free
NULL_DIR	the direction has been specified to be always null
SPECIFIED	the direction has been specified to be something imposed but not null (even 0.0 is possible!)
TOWARD	the direction is set dynamically depending on the "toward" position

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 towardIndex.

◆ Direction() [3/4]

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

inline

constructor with initialization of the 3 directions

References NOT_SPECIFIED, and NULL_DIR.

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

◆ getY()

double Direction::getY ( ) const

inline

get the y coordinate

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

◆ getZ()

double Direction::getZ ( ) const

inline

get the z coordinate

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

◆ isToward()

bool Direction::isToward ( ) const

inline

true only if the direction is set by a toward atom

References NULL_DIR, x, and xState.

◆ isXNull()

bool Direction::isXNull ( ) const

inline

is the x coordinate NULL ?

References y.

Referenced by Translation::ansysPrint().

◆ isXSpecified()

bool Direction::isXSpecified ( ) const

inline

is the x coordinate specified

References NULL_DIR, and yState.

◆ isYNull()

bool Direction::isYNull ( ) const

inline

is the y coordinate NULL ?

Referenced by Translation::ansysPrint().

◆ isYSpecified()

bool Direction::isYSpecified ( ) const

inline

is the y coordinate specified

◆ isZNull()

bool Direction::isZNull ( ) const

inline

is the z coordinate NULL ?

References NOT_SPECIFIED, and NULL_DIR.

Referenced by Translation::ansysPrint().

◆ isZSpecified()

bool Direction::isZSpecified ( ) const

inline

is the z coordinate specified

◆ set()

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

inline

set the direction

References x.

Referenced by Load::setDirection().

◆ setNullX()

void Direction::setNullX ( )

inline

set the x coordinate as NULL

References SPECIFIED, and yState.

Referenced by GenerateModel::saveMMLFiles().

◆ setNullY()

void Direction::setNullY ( )

inline

set the y coordinate as NULL

Referenced by GenerateModel::saveMMLFiles().

◆ setNullZ()

void Direction::setNullZ ( )

inline

set the z coordinate as NULL

Referenced by GenerateModel::saveMMLFiles().

◆ setToward()

void Direction::setToward ( const unsigned int toward )

inline

set the toward index

Referenced by Loads::xmlRead().

◆ setX()

void Direction::setX ( const double x )

inline

set the x coordinate

Referenced by Loads::xmlRead().

◆ setY()

void Direction::setY ( const double y )

inline

set the y coordinate

References NULL_DIR, z, and zState.

Referenced by Loads::xmlRead().

◆ setZ()

void Direction::setZ ( const double z )

inline

set the z coordinate

References NOT_SPECIFIED.

Referenced by Loads::xmlRead().

◆ xmlPrint()

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

inline

print to an ostream

Referenced by Load::xmlPrint().

Member Data Documentation

◆ towardIndex

int Direction::towardIndex {-1}

private

toward atom index

Referenced by Direction().

◆ x

double Direction::x {0.0}

private

x coordinates

Referenced by isToward(), and set().

◆ xState

DirState Direction::xState {NOT_SPECIFIED}

private

state for the x coordinates

Referenced by isToward().

◆ y

double Direction::y {0.0}

private

y coordinates

Referenced by isXNull().

◆ yState

DirState Direction::yState {NOT_SPECIFIED}

private

state for the y coordinates

Referenced by isXSpecified(), and setNullX().

◆ z

double Direction::z {0.0}

private

z coordinates

Referenced by setY().

◆ zState

DirState Direction::zState {NOT_SPECIFIED}

private

state for the z coordinates

Referenced by setY().

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

Direction.h

Public Member Functions

Z direction

Detailed Description

Member Enumeration Documentation

◆ DirState

Constructor & Destructor Documentation

◆ Direction() [1/4]

◆ Direction() [2/4]

◆ Direction() [3/4]

◆ Direction() [4/4]

Member Function Documentation

◆ getToward()

◆ getX()

◆ getY()

◆ getZ()

◆ isToward()

◆ isXNull()

◆ isXSpecified()

◆ isYNull()

◆ isYSpecified()

◆ isZNull()

◆ isZSpecified()

◆ set()

◆ setNullX()

◆ setNullY()

◆ setNullZ()

◆ setToward()

◆ setX()

◆ setY()

◆ setZ()

◆ xmlPrint()

Member Data Documentation

◆ towardIndex

◆ x

◆ xState

◆ y

◆ yState

◆ z

◆ zState