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 More...
	DtIfEmbarkObject (const DtIfEmbarkObject &orig)
	copy constructor More...
const DtIfEmbarkObject &	operator= (const DtIfEmbarkObject &orig)
	assignment operator More...
virtual	~DtIfEmbarkObject ()
virtual int	type () const
	Returns DtQuerySpatialSubdivisionConfigurationType, defined in msgTypes.h. More...
virtual DtSimInterfaceContent *	clone () const
	Returns newly created copy of this object. More...
virtual void	setEmbarkObject (const DtUUID &)
virtual const DtUUID &	embarkObject () const
virtual void	setParent (const DtUUID &)
virtual const DtUUID &	parent () const
virtual void	setLoadOverride (bool)
virtual bool	loadOverride () const
virtual void	setUseSlotIfAvailable (bool)
	Even if load override is specified, use the slot if available. If not then use load override position. More...
virtual bool	useSlotIfAvailable () 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. More...
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Unpack network representation (contentBuffer) into this object. More...
virtual bool	setToNet ()
	Package this object's data into a network format (a DtNetIfQuerySpatialSubdivisionConfiguration struct). More...
virtual void	printDataToString (DtString &str)
	Human readable representation of this object's data (used for debugging purposes, and in applications such as vrfMsgDump). More...
virtual void	setEmbarkInSlot (int s)
	In trying to say where an entity will embark, you can use two forms – one is the slot number (non -1 means use that exact slot) If the slot number is -1 and the slot name or slot type are set, it will try and match the slot number by that name and type. More...
virtual int	embarkInSlot () const
virtual void	setSlotName (const DtString &)
virtual const DtString &	slotName () const
virtual void	setSlotType (const DtString &)
virtual const DtString &	slotType () const
virtual void	setChooseAnyAvailableSlotIfTaken (bool)
virtual bool	chooseAnyAvailableSlotIfTaken () 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 ()
	Returns a new instance of this class. More...
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
bool	myLoadOverride
bool	myUseSlotIfAvailable
DtVector	myLoadOverridePosition
int	myEmbarkInSlot
bool	myChooseAnyAvailableIfSlotTaken
DtString	mySlotName
DtString	mySlotType
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

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.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfEmbarkObject::clone ( ) const

virtual

Returns newly created copy of this object.

Implements DtSimInterfaceContent.

virtual void DtIfEmbarkObject::setEmbarkObject ( const DtUUID &  )

virtual

virtual const DtUUID& DtIfEmbarkObject::embarkObject ( ) const

virtual

virtual void DtIfEmbarkObject::setParent ( const DtUUID &  )

virtual

virtual const DtUUID& DtIfEmbarkObject::parent ( ) const

virtual

virtual void DtIfEmbarkObject::setLoadOverride ( bool  )

virtual

virtual bool DtIfEmbarkObject::loadOverride ( ) const

virtual

virtual void DtIfEmbarkObject::setUseSlotIfAvailable ( bool  )

virtual

Even if load override is specified, use the slot if available. If not then use load override position.

virtual bool DtIfEmbarkObject::useSlotIfAvailable ( ) 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.

Reimplemented from DtSimInterfaceContent.

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

virtual

Unpack network representation (contentBuffer) into this object.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfEmbarkObject::setToNet ( )

virtual

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

Reimplemented from DtSimInterfaceContent.

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

Reimplemented from DtSimInterfaceContent.

virtual void DtIfEmbarkObject::setEmbarkInSlot ( int  s )

virtual

In trying to say where an entity will embark, you can use two forms – one is the slot number (non -1 means use that exact slot) If the slot number is -1 and the slot name or slot type are set, it will try and match the slot number by that name and type.

• for either name or type will mean to match the first available slot that matches. If -1 and * are used for all, then it will just get the first available slot

virtual int DtIfEmbarkObject::embarkInSlot ( ) const

virtual

virtual void DtIfEmbarkObject::setSlotName ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkObject::slotName ( ) const

virtual

virtual void DtIfEmbarkObject::setSlotType ( const DtString &  )

virtual

virtual const DtString& DtIfEmbarkObject::slotType ( ) const

virtual

virtual void DtIfEmbarkObject::setChooseAnyAvailableSlotIfTaken ( bool  )

virtual

virtual bool DtIfEmbarkObject::chooseAnyAvailableSlotIfTaken ( ) const

virtual

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

DtUUID DtIfEmbarkObject::myEmbarkObject

protected

DtUUID DtIfEmbarkObject::myParent

protected

bool DtIfEmbarkObject::myLoadOverride

protected

bool DtIfEmbarkObject::myUseSlotIfAvailable

protected

DtVector DtIfEmbarkObject::myLoadOverridePosition

protected

int DtIfEmbarkObject::myEmbarkInSlot

protected

bool DtIfEmbarkObject::myChooseAnyAvailableIfSlotTaken

protected

DtString DtIfEmbarkObject::mySlotName

protected

DtString DtIfEmbarkObject::mySlotType

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmsgs/ifEmbarkObject.h