DtIfDisembarkObject Class Reference

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

Inheritance diagram for DtIfDisembarkObject:

List of all members.

Public Member Functions
	DtIfDisembarkObject ()
	default constructor
	DtIfDisembarkObject (const DtIfDisembarkObject &orig)
	copy constructor
const DtIfDisembarkObject &	operator= (const DtIfDisembarkObject &orig)
	assignment operator
virtual	~DtIfDisembarkObject ()
virtual int	type () const
	Returns DtQuerySpatialSubdivisionConfigurationType, defined in msgTypes.h.
virtual DtSimInterfaceContent *	clone () const
	Returns newly created copy of this object.
virtual void	setDisembarkObject (const DtString &)
virtual const DtString &	disembarkObject () 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	setDisembarkAll (bool b)
	If true (default is false) disembark all objects that are embarked on this object.
virtual bool	disembarkAll () const
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
	Returns a new instance of this class.
Protected Attributes
DtString	myDisembarkObject
bool	myDisembarkAll

---

Detailed Description

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

Content-Type: DtDisembarkObject

---

Constructor & Destructor Documentation

DtIfDisembarkObject::DtIfDisembarkObject

(

)

default constructor

DtIfDisembarkObject::DtIfDisembarkObject

(

const DtIfDisembarkObject &

orig

)

copy constructor

virtual DtIfDisembarkObject::~DtIfDisembarkObject

(

)

[virtual]

---

Member Function Documentation

const DtIfDisembarkObject& DtIfDisembarkObject::operator=

(

const DtIfDisembarkObject &

orig

)

assignment operator

virtual int DtIfDisembarkObject::type

(

)

const [virtual]

Returns DtQuerySpatialSubdivisionConfigurationType, defined in msgTypes.h.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfDisembarkObject::clone

(

)

const [virtual]

Returns newly created copy of this object.

Implements DtSimInterfaceContent.

virtual void DtIfDisembarkObject::setDisembarkObject

(

const DtString &

)

[virtual]

virtual const DtString& DtIfDisembarkObject::disembarkObject

(

)

const [virtual]

virtual int DtIfDisembarkObject::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSimInterfaceContent.

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

Unpack network representation (contentBuffer) into this object.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfDisembarkObject::setToNet

(

)

[virtual]

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

Reimplemented from DtSimInterfaceContent.

virtual void DtIfDisembarkObject::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* DtIfDisembarkObject::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 DtIfDisembarkObject::setDisembarkAll

(

bool

b

)

[virtual]

If true (default is false) disembark all objects that are embarked on this object.

If this flag is true, the disembark object is the parent of the objects to disembark

virtual bool DtIfDisembarkObject::disembarkAll

(

)

const [virtual]

---

Member Data Documentation

DtString DtIfDisembarkObject::myDisembarkObject [protected]

bool DtIfDisembarkObject::myDisembarkAll [protected]

---

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

• include/vrfmsgs/ifDisembarkObject.h