DtIfEmbarkObject Class Reference

Instances of this class are the interface message content used to embark an object on the specified parent. More...

Inheritance diagram for DtIfEmbarkObject:

Public Member Functions
	DtIfEmbarkObject ()
	default constructor
	DtIfEmbarkObject (const DtIfEmbarkObject &orig)
	copy constructor
const DtIfEmbarkObject &	operator= (const DtIfEmbarkObject &orig)
	assignment operator
virtual	~DtIfEmbarkObject ()
virtual int	type () const
	Returns DtQuerySpatialSubdivisionConfigurationType, 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	setLoadOverride (bool)
virtual bool	loadOverride () const
virtual void	setLoadOverridePosition (const DtVector &)
virtual const DtVector &	loadOverridePosition () 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).

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

Protected Attributes
DtString	myEmbarkObject
DtString	myParent
bool	myLoadOverride
DtVector	myLoadOverridePosition

Detailed Description

Instances of this class are the interface message content used to embark an object on the specified parent.

Content-Type: DtIfEmbarkObject

Constructor & Destructor Documentation

DtIfEmbarkObject::DtIfEmbarkObject

(

)

default constructor

DtIfEmbarkObject::DtIfEmbarkObject

(

const DtIfEmbarkObject &

orig

)

copy constructor

virtual DtIfEmbarkObject::~DtIfEmbarkObject ( )

virtual

Member Function Documentation

const DtIfEmbarkObject& DtIfEmbarkObject::operator=

(

const DtIfEmbarkObject &

orig

)

assignment operator

virtual int DtIfEmbarkObject::type ( ) const

virtual

Returns DtQuerySpatialSubdivisionConfigurationType, defined in msgTypes.h.

virtual DtSimInterfaceContent* DtIfEmbarkObject::clone ( ) const

virtual

Returns newly created copy of this object.

virtual void DtIfEmbarkObject::setEmbarkObject ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkObject::embarkObject ( ) const

virtual

virtual void DtIfEmbarkObject::setParent ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkObject::parent ( ) const

virtual

virtual void DtIfEmbarkObject::setLoadOverride ( bool  )

virtual

virtual bool DtIfEmbarkObject::loadOverride ( ) const

virtual

virtual void DtIfEmbarkObject::setLoadOverridePosition ( const DtVector &  )

virtual

virtual const DtVector& DtIfEmbarkObject::loadOverridePosition ( ) const

virtual

virtual int DtIfEmbarkObject::netRepSize ( ) const

virtual

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

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

virtual

Unpack network representation (contentBuffer) into this object.

virtual bool DtIfEmbarkObject::setToNet ( )

virtual

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

virtual void DtIfEmbarkObject::printDataToString ( DtString &  str )

virtual

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

static DtSimInterfaceContent* DtIfEmbarkObject::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.

Member Data Documentation

DtString DtIfEmbarkObject::myEmbarkObject

protected

DtString DtIfEmbarkObject::myParent

protected

bool DtIfEmbarkObject::myLoadOverride

protected

DtVector DtIfEmbarkObject::myLoadOverridePosition

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifEmbarkObject.h