DtIfRequestEmbarkationInformation Class Reference

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

Inheritance diagram for DtIfRequestEmbarkationInformation:

List of all members.

Public Member Functions
	DtIfRequestEmbarkationInformation ()
	default constructor
	DtIfRequestEmbarkationInformation (const DtIfRequestEmbarkationInformation &orig)
	copy constructor
const DtIfRequestEmbarkationInformation &	operator= (const DtIfRequestEmbarkationInformation &orig)
	assignment operator
virtual	~DtIfRequestEmbarkationInformation ()
virtual int	type () const
	Returns DtEmbarkationInformationRequestType, 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	setRequestType (short)
virtual short	requestType () 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	setRequestId (DtU32)
	Used to fill in response id for response structure. Default is 0xFFFFFFFF.
virtual DtU32	requestId () const
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
	Returns a new instance of this class.
Protected Attributes
DtString	myEmbarkObject
DtString	myParent
short	myRequestType
DtU32	myRequestId

---

Detailed Description

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

Content-Type: DtIfRequestEmbarkationInformation

---

Constructor & Destructor Documentation

DtIfRequestEmbarkationInformation::DtIfRequestEmbarkationInformation

(

)

default constructor

DtIfRequestEmbarkationInformation::DtIfRequestEmbarkationInformation

(

const DtIfRequestEmbarkationInformation &

orig

)

copy constructor

virtual DtIfRequestEmbarkationInformation::~DtIfRequestEmbarkationInformation

(

)

[virtual]

---

Member Function Documentation

const DtIfRequestEmbarkationInformation& DtIfRequestEmbarkationInformation::operator=

(

const DtIfRequestEmbarkationInformation &

orig

)

assignment operator

virtual int DtIfRequestEmbarkationInformation::type

(

)

const [virtual]

Returns DtEmbarkationInformationRequestType, defined in msgTypes.h.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestEmbarkationInformation::clone

(

)

const [virtual]

Returns newly created copy of this object.

Implements DtSimInterfaceContent.

virtual void DtIfRequestEmbarkationInformation::setEmbarkObject

(

const DtString &

)

[virtual]

virtual const DtString& DtIfRequestEmbarkationInformation::embarkObject

(

)

const [virtual]

virtual void DtIfRequestEmbarkationInformation::setParent

(

const DtString &

)

[virtual]

virtual const DtString& DtIfRequestEmbarkationInformation::parent

(

)

const [virtual]

virtual void DtIfRequestEmbarkationInformation::setRequestType

(

short

)

[virtual]

virtual short DtIfRequestEmbarkationInformation::requestType

(

)

const [virtual]

virtual int DtIfRequestEmbarkationInformation::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestEmbarkationInformation::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Unpack network representation (contentBuffer) into this object.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestEmbarkationInformation::setToNet

(

)

[virtual]

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

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestEmbarkationInformation::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 DtIfRequestEmbarkationInformation::setRequestId

(

DtU32

)

[virtual]

Used to fill in response id for response structure. Default is 0xFFFFFFFF.

virtual DtU32 DtIfRequestEmbarkationInformation::requestId

(

)

const [virtual]

static DtSimInterfaceContent* DtIfRequestEmbarkationInformation::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 DtIfRequestEmbarkationInformation::myEmbarkObject [protected]

DtString DtIfRequestEmbarkationInformation::myParent [protected]

short DtIfRequestEmbarkationInformation::myRequestType [protected]

DtU32 DtIfRequestEmbarkationInformation::myRequestId [protected]

---

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

• include/vrfmsgs/ifRequestEmbarkationInformation.h