DtIfEmbarkationInformation Class Reference

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

Inheritance diagram for DtIfEmbarkationInformation:

Public Member Functions
	DtIfEmbarkationInformation ()
	default constructor
	DtIfEmbarkationInformation (const DtIfEmbarkationInformation &orig)
	copy constructor
const DtIfEmbarkationInformation &	operator= (const DtIfEmbarkationInformation &orig)
	assignment operator
virtual	~DtIfEmbarkationInformation ()
virtual int	type () const
	Returns DtEmbarkationInformationType, defined in msgTypes.h.
virtual DtSimInterfaceContent *	clone () const
	Returns newly created copy of this object.
virtual void	setEmbarkObject (const DtString &)
virtual const DtString &	embarkObject () const
virtual void	setParent (const DtString &)
virtual const DtString &	parent () const
virtual void	setResult (short)
virtual short	result () const
virtual void	setSlot (int)
virtual int	slot () const
virtual void	setEmbarkedAppearance (int)
virtual int	embarkedAppearance () const
virtual void	setJumpToLocation (bool)
virtual bool	jumpToLocation () const
virtual void	setTurnToHeading (bool)
virtual bool	turnToHeading () 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
	Returns size of network representation of this object, in bytes.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Unpack network representation (contentBuffer) into this object.
virtual bool	setToNet ()
	Package this object's data into a network format (a DtNetIfQuerySpatialSubdivisionConfiguration struct).
virtual void	printDataToString (DtString &str)
	Human readable representation of this object's data (used for debugging purposes, and in applications such as vrfMsgDump).
virtual void	setPublishLoadPoints (bool)
virtual bool	publishLoadPoints () const
Public Member Functions inherited from DtIfServerRequestResponse
	DtIfServerRequestResponse ()
	default constructor
	DtIfServerRequestResponse (const DtIfServerRequestResponse &orig)
	copy constructor
const DtIfServerRequestResponse &	operator= (const DtIfServerRequestResponse &orig)
	assignment operator
virtual	~DtIfServerRequestResponse ()
virtual void	setResponseId (const DtU32 &id)
const DtU32 &	responseId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
	Returns a new instance of this class.

Protected Attributes
DtString	myEmbarkObject
DtString	myParent
short	myResult
int	mySlot
int	myEmbarkedAppearance
DtTaitBryan	myEmbarkedOrientation
DtVector	myEmbarkedPosition
std::vector< DtVector >	myLoadPath
bool	myPublishLoadPoints
bool	myJumpToLocation
bool	myTurnToHeading
Protected Attributes inherited from DtIfServerRequestResponse
DtU32	myResponseId

Detailed Description

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

Content-Type: DtIfEmbarkationInformation

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.

virtual DtSimInterfaceContent* DtIfEmbarkationInformation::clone ( ) const

virtual

Returns newly created copy of this object.

virtual void DtIfEmbarkationInformation::setEmbarkObject ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkationInformation::embarkObject ( ) const

virtual

virtual void DtIfEmbarkationInformation::setParent ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkationInformation::parent ( ) const

virtual

virtual void DtIfEmbarkationInformation::setResult ( short  )

virtual

virtual short DtIfEmbarkationInformation::result ( ) const

virtual

virtual void DtIfEmbarkationInformation::setSlot ( int  )

virtual

virtual int DtIfEmbarkationInformation::slot ( ) const

virtual

virtual void DtIfEmbarkationInformation::setEmbarkedAppearance ( int  )

virtual

virtual int DtIfEmbarkationInformation::embarkedAppearance ( ) const

virtual

virtual void DtIfEmbarkationInformation::setJumpToLocation ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::jumpToLocation ( ) const

virtual

virtual void DtIfEmbarkationInformation::setTurnToHeading ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::turnToHeading ( ) 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.

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

virtual

Unpack network representation (contentBuffer) into this object.

virtual bool DtIfEmbarkationInformation::setToNet ( )

virtual

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

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

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::setPublishLoadPoints ( bool  )

virtual

virtual bool DtIfEmbarkationInformation::publishLoadPoints ( ) const

virtual

Member Data Documentation

DtString DtIfEmbarkationInformation::myEmbarkObject

protected

DtString DtIfEmbarkationInformation::myParent

protected

short DtIfEmbarkationInformation::myResult

protected

int DtIfEmbarkationInformation::mySlot

protected

int DtIfEmbarkationInformation::myEmbarkedAppearance

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfmsgs/ifEmbarkationInformation.h