DtIfEmbarkationInformation Class Reference

Instances of this class are the interface message content used to request return requested embarkation information.

Content-Type: DtIfEmbarkationInformation

Inheritance diagram for DtIfEmbarkationInformation:

Public Member Functions
	DtIfEmbarkationInformation ()
	DtIfEmbarkationInformation (const DtIfEmbarkationInformation &orig)
const DtIfEmbarkationInformation &	operator= (const DtIfEmbarkationInformation &orig)
virtual	~DtIfEmbarkationInformation ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual void	setEmbarkObject (const DtUUID &)
virtual const DtUUID &	embarkObject () const
virtual void	setParent (const DtUUID &)
virtual const DtUUID &	parent () const
virtual void	setResult (int)
virtual int	result () const
virtual void	setSlot (int)
virtual int	slot () const
virtual void	setSlotName (const DtString &)
virtual const DtString &	slotName () const
virtual void	setSlotType (const DtString &)
virtual const DtString &	slotType () const
virtual void	setStationName (int)
virtual int	stationName () const
virtual void	setEmbarkedAppearance (int)
virtual int	embarkedAppearance () const
virtual void	setEmbarkedAnimation (const DtString &)
virtual const DtString &	embarkedAnimation () const
virtual void	setJumpToLocation (bool)
virtual bool	jumpToLocation () const
virtual void	setInvisibleWhenEmbarked (bool)
virtual bool	invisibleWhenEmbarked () const
virtual void	setTurnToHeading (bool)
virtual bool	turnToHeading () const
virtual void	setOrientOnIngress (bool)
virtual bool	orientOnIngress () const
virtual void	setEmbarkedOrientation (const DtTaitBryan &)
virtual const DtTaitBryan &	embarkedOrientation () const
virtual void	setEmbarkedPosition (const DtVector &)
virtual const DtVector &	embarkedPosition () const
virtual void	setLoadPath (const std::vector< DtVector > &)
virtual void	addLoadPathPoint (const DtVector &)
virtual const std::vector < DtVector > &	loadPath () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual void	setTechnique (const DtString &)
virtual const DtString &	technique () const
virtual void	setPublishLoadPoints (bool)
virtual bool	publishLoadPoints () const
Public Member Functions inherited from DtIfServerRequestResponse
	DtIfServerRequestResponse ()
	DtIfServerRequestResponse (const DtIfServerRequestResponse &orig)
const DtIfServerRequestResponse &	operator= (const DtIfServerRequestResponse &orig)
virtual	~DtIfServerRequestResponse ()
virtual void	setResponseId (const DtU32 &id)
const DtU32 &	responseId () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtUUID	myEmbarkObject
DtUUID	myParent
int	myResult
int	mySlot
int	myEmbarkedAppearance
DtString	myEmbarkedAnimation
DtString	myTechnique
DtString	mySlotName
DtString	mySlotType
int	myStationName
DtTaitBryan	myEmbarkedOrientation
DtVector	myEmbarkedPosition
std::vector< DtVector >	myLoadPath
bool	myPublishLoadPoints
bool	myJumpToLocation
bool	myTurnToHeading
bool	myOrientOnIngress
bool	myInvisibleWhenEmbarked
Protected Attributes inherited from DtIfServerRequestResponse
DtU32	myResponseId
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfEmbarkationInformation::DtIfEmbarkationInformation

(

)

default constructor

DtIfEmbarkationInformation::DtIfEmbarkationInformation

(

const DtIfEmbarkationInformation &

orig

)

copy constructor

virtual DtIfEmbarkationInformation::~DtIfEmbarkationInformation ( )

virtual

Member Function Documentation

const DtIfEmbarkationInformation& DtIfEmbarkationInformation::operator=

(

const DtIfEmbarkationInformation &

orig

)

assignment operator

virtual int DtIfEmbarkationInformation::type ( ) const

virtual

Returns DtEmbarkationInformationType, defined in msgTypes.h.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfEmbarkationInformation::clone ( ) const

virtual

Returns newly created copy of this object.

Implements DtSimInterfaceContent.

virtual void DtIfEmbarkationInformation::setEmbarkObject ( const DtUUID &  )

virtual

virtual const DtUUID& DtIfEmbarkationInformation::embarkObject ( ) const

virtual

virtual void DtIfEmbarkationInformation::setParent ( const DtUUID &  )

virtual

virtual const DtUUID& DtIfEmbarkationInformation::parent ( ) const

virtual

virtual void DtIfEmbarkationInformation::setResult ( int  )

virtual

virtual int DtIfEmbarkationInformation::result ( ) const

virtual

virtual void DtIfEmbarkationInformation::setSlot ( int  )

virtual

virtual int DtIfEmbarkationInformation::slot ( ) const

virtual

virtual void DtIfEmbarkationInformation::setSlotName ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkationInformation::slotName ( ) const

virtual

virtual void DtIfEmbarkationInformation::setSlotType ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkationInformation::slotType ( ) const

virtual

virtual void DtIfEmbarkationInformation::setStationName ( int  )

virtual

virtual int DtIfEmbarkationInformation::stationName ( ) const

virtual

virtual void DtIfEmbarkationInformation::setEmbarkedAppearance ( int  )

virtual

virtual int DtIfEmbarkationInformation::embarkedAppearance ( ) const

virtual

virtual void DtIfEmbarkationInformation::setEmbarkedAnimation ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkationInformation::embarkedAnimation ( ) const

virtual

virtual void DtIfEmbarkationInformation::setJumpToLocation ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::jumpToLocation ( ) const

virtual

virtual void DtIfEmbarkationInformation::setInvisibleWhenEmbarked ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::invisibleWhenEmbarked ( ) const

virtual

virtual void DtIfEmbarkationInformation::setTurnToHeading ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::turnToHeading ( ) const

virtual

virtual void DtIfEmbarkationInformation::setOrientOnIngress ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::orientOnIngress ( ) const

virtual

virtual void DtIfEmbarkationInformation::setEmbarkedOrientation ( const DtTaitBryan &  )

virtual

virtual const DtTaitBryan& DtIfEmbarkationInformation::embarkedOrientation ( ) const

virtual

virtual void DtIfEmbarkationInformation::setEmbarkedPosition ( const DtVector &  )

virtual

virtual const DtVector& DtIfEmbarkationInformation::embarkedPosition ( ) const

virtual

virtual void DtIfEmbarkationInformation::setLoadPath ( const std::vector< DtVector > &  )

virtual

virtual void DtIfEmbarkationInformation::addLoadPathPoint ( const DtVector &  )

virtual

virtual const std::vector<DtVector>& DtIfEmbarkationInformation::loadPath ( ) const

virtual

virtual int DtIfEmbarkationInformation::netRepSize ( ) const

virtual

Returns size of network representation of this object, in bytes.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfEmbarkationInformation::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Unpack network representation (contentBuffer) into this object.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfEmbarkationInformation::setToNet ( )

virtual

Package this object's data into a network format (a DtNetIfQuerySpatialSubdivisionConfiguration struct).

Reimplemented from DtSimInterfaceContent.

virtual void DtIfEmbarkationInformation::printDataToString ( DtString &  str )

virtual

Human readable representation of this object's data (used for debugging purposes, and in applications such as vrfMsgDump).

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfEmbarkationInformation::creator ( )

static

Returns a new instance of this class. This function is registered with the DtInterfaceContentFactory with a key returned by the type() member function.

virtual void DtIfEmbarkationInformation::setTechnique ( const DtString &  )

virtual

The technique that is used for embark/disembark (if supplied)

virtual const DtString& DtIfEmbarkationInformation::technique ( ) const

virtual

virtual void DtIfEmbarkationInformation::setPublishLoadPoints ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::publishLoadPoints ( ) const

virtual

Member Data Documentation

DtUUID DtIfEmbarkationInformation::myEmbarkObject

protected

DtUUID DtIfEmbarkationInformation::myParent

protected

int DtIfEmbarkationInformation::myResult

protected

int DtIfEmbarkationInformation::mySlot

protected

int DtIfEmbarkationInformation::myEmbarkedAppearance

protected

DtString DtIfEmbarkationInformation::myEmbarkedAnimation

protected

DtString DtIfEmbarkationInformation::myTechnique

protected

DtString DtIfEmbarkationInformation::mySlotName

protected

DtString DtIfEmbarkationInformation::mySlotType

protected

int DtIfEmbarkationInformation::myStationName

protected

DtTaitBryan DtIfEmbarkationInformation::myEmbarkedOrientation

protected

DtVector DtIfEmbarkationInformation::myEmbarkedPosition

protected

std::vector<DtVector> DtIfEmbarkationInformation::myLoadPath

protected

bool DtIfEmbarkationInformation::myPublishLoadPoints

protected

bool DtIfEmbarkationInformation::myJumpToLocation

protected

bool DtIfEmbarkationInformation::myTurnToHeading

protected

bool DtIfEmbarkationInformation::myOrientOnIngress

protected

bool DtIfEmbarkationInformation::myInvisibleWhenEmbarked

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/ifEmbarkationInformation.h