DtEmbarkationInformation Class Reference

Class that will keep track of all embarkation information. More...

Public Types
typedef std::vector< DtLoadPoint >	LoadPoints
typedef std::vector < DtEmbarkationSlotEntry >	EmbarkationSlots
typedef std::vector < DtSlotExclusion >	SlotExclusions

Public Member Functions
	DtEmbarkationInformation ()
	CTOR.
virtual	~DtEmbarkationInformation ()
	DTOR.
	DtEmbarkationInformation (const DtEmbarkationInformation &)
	Copy constructor.
DtEmbarkationInformation &	operator= (const DtEmbarkationInformation &)
bool	operator== (const DtEmbarkationInformation &) const
bool	operator!= (const DtEmbarkationInformation &rhs)
virtual void	readFromEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode)
	Seeds list from environment. Will clear out all current information.
virtual void	writeToEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode) const
	Writes all information to the environment, removing all old information first.
virtual void	removeSlot (int index)
virtual void	removeSlotExclusion (int index)
virtual void	removeIngressPoint (int index)
virtual void	removeEgressPoint (int index)
virtual void	removeIngressLoadPoint (int lp, int index)
virtual void	removeEgressLoadPoint (int lp, int index)
virtual void	removeLoadPoint (DtLoadPoint &lp, int index)
const LoadPoints &	ingressPoints () const
LoadPoints &	ingressPoints ()
const LoadPoints &	egressPoints () const
LoadPoints &	egressPoints ()
const EmbarkationSlots &	embarkationSlots () const
EmbarkationSlots &	embarkationSlots ()
const SlotExclusions &	slotExclusions () const
SlotExclusions &	slotExclusions ()
bool	flipDisembarkBodyX ()
void	setFlipDisembarkBodyX (bool flip)
bool	flipDisembarkBodyY ()
void	setFlipDisembarkBodyY (bool flip)
virtual LoadPoints	readLoadPoints (DtEnvironmentSP e, DtEnvValueSP objectNode, const DtString &pointType) const
virtual EmbarkationSlots	readEmbarkationSlots (DtEnvironmentSP e, DtEnvValueSP objectNode) const
virtual SlotExclusions	readSlotExclusions (DtEnvironmentSP e, DtEnvValueSP objectNode) const
bool	readBooleanObject (DtEnvironmentSP e, DtEnvValueSP objectNode, const DtString &objectName) const
virtual void	writeLoadPoints (const LoadPoints &, DtEnvironmentSP e, DtEnvValueSP objectNode, const DtString &pointType) const
virtual void	writeEmbarkationSlots (const EmbarkationSlots &, DtEnvironmentSP e, DtEnvValueSP objectNode) const
virtual void	writeSlotExclusions (const SlotExclusions &, DtEnvironmentSP e, DtEnvValueSP objectNode) const

Protected Attributes
LoadPoints	myIngressPoints
LoadPoints	myEgressPoints
EmbarkationSlots	myEmbarkationSlots
SlotExclusions	mySlotExclusions
bool	myFlipDisembarkBodyX
bool	myFlipDisembarkBodyY

Detailed Description

Class that will keep track of all embarkation information.

Member Typedef Documentation

typedef std::vector<DtLoadPoint> DtEmbarkationInformation::LoadPoints

typedef std::vector<DtEmbarkationSlotEntry> DtEmbarkationInformation::EmbarkationSlots

typedef std::vector<DtSlotExclusion> DtEmbarkationInformation::SlotExclusions

Constructor & Destructor Documentation

DtEmbarkationInformation::DtEmbarkationInformation

(

)

CTOR.

virtual DtEmbarkationInformation::~DtEmbarkationInformation ( )

virtual

DTOR.

DtEmbarkationInformation::DtEmbarkationInformation

(

const DtEmbarkationInformation &

)

Copy constructor.

Member Function Documentation

DtEmbarkationInformation& DtEmbarkationInformation::operator=

(

const DtEmbarkationInformation &

)

bool DtEmbarkationInformation::operator==

(

const DtEmbarkationInformation &

)

const

bool DtEmbarkationInformation::operator!= ( const DtEmbarkationInformation &  rhs )

inline

virtual void DtEmbarkationInformation::readFromEnvironment ( DtEnvironmentSP  , DtEnvValueSP  objectNode  )

virtual

Seeds list from environment. Will clear out all current information.

virtual void DtEmbarkationInformation::writeToEnvironment ( DtEnvironmentSP  , DtEnvValueSP  objectNode  ) const

virtual

Writes all information to the environment, removing all old information first.

virtual void DtEmbarkationInformation::removeSlot ( int  index )

virtual

virtual void DtEmbarkationInformation::removeSlotExclusion ( int  index )

virtual

virtual void DtEmbarkationInformation::removeIngressPoint ( int  index )

virtual

virtual void DtEmbarkationInformation::removeEgressPoint ( int  index )

virtual

virtual void DtEmbarkationInformation::removeIngressLoadPoint ( int  lp, int  index  )

virtual

virtual void DtEmbarkationInformation::removeEgressLoadPoint ( int  lp, int  index  )

virtual

virtual void DtEmbarkationInformation::removeLoadPoint ( DtLoadPoint &  lp, int  index  )

virtual

const LoadPoints& DtEmbarkationInformation::ingressPoints ( ) const

inline

LoadPoints& DtEmbarkationInformation::ingressPoints ( )

inline

const LoadPoints& DtEmbarkationInformation::egressPoints ( ) const

inline

LoadPoints& DtEmbarkationInformation::egressPoints ( )

inline

const EmbarkationSlots& DtEmbarkationInformation::embarkationSlots ( ) const

inline

EmbarkationSlots& DtEmbarkationInformation::embarkationSlots ( )

inline

const SlotExclusions& DtEmbarkationInformation::slotExclusions ( ) const

inline

SlotExclusions& DtEmbarkationInformation::slotExclusions ( )

inline

bool DtEmbarkationInformation::flipDisembarkBodyX ( )

inline

void DtEmbarkationInformation::setFlipDisembarkBodyX ( bool  flip )

inline

bool DtEmbarkationInformation::flipDisembarkBodyY ( )

inline

void DtEmbarkationInformation::setFlipDisembarkBodyY ( bool  flip )

inline

virtual LoadPoints DtEmbarkationInformation::readLoadPoints ( DtEnvironmentSP  e, DtEnvValueSP  objectNode, const DtString &  pointType  ) const

virtual

virtual EmbarkationSlots DtEmbarkationInformation::readEmbarkationSlots ( DtEnvironmentSP  e, DtEnvValueSP  objectNode  ) const

virtual

virtual SlotExclusions DtEmbarkationInformation::readSlotExclusions ( DtEnvironmentSP  e, DtEnvValueSP  objectNode  ) const

virtual

bool DtEmbarkationInformation::readBooleanObject	(	DtEnvironmentSP	e,
		DtEnvValueSP	objectNode,
		const DtString &	objectName
	)		const

virtual void DtEmbarkationInformation::writeLoadPoints ( const LoadPoints &  , DtEnvironmentSP  e, DtEnvValueSP  objectNode, const DtString &  pointType  ) const

virtual

virtual void DtEmbarkationInformation::writeEmbarkationSlots ( const EmbarkationSlots &  , DtEnvironmentSP  e, DtEnvValueSP  objectNode  ) const

virtual

virtual void DtEmbarkationInformation::writeSlotExclusions ( const SlotExclusions &  , DtEnvironmentSP  e, DtEnvValueSP  objectNode  ) const

virtual

Member Data Documentation

LoadPoints DtEmbarkationInformation::myIngressPoints

protected

LoadPoints DtEmbarkationInformation::myEgressPoints

protected

EmbarkationSlots DtEmbarkationInformation::myEmbarkationSlots

protected

SlotExclusions DtEmbarkationInformation::mySlotExclusions

protected

bool DtEmbarkationInformation::myFlipDisembarkBodyX

protected

bool DtEmbarkationInformation::myFlipDisembarkBodyY

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/simulationObjectEditorImpl/embarkationInformation.h