Instances of DtArealObjectStatePdu are used to communicate information about the addition/modification of a synthetic object which is geometrically anchored to the terrain with multiple points. More...

Inheritance diagram for DtArealObjectStatePdu:

Collaboration diagram for DtArealObjectStatePdu:

Public Member Functions
	DtArealObjectStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtArealObjectStatePdu (const DtNetArealObjectStatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtArealObjectStatePdu (const DtArealObjectStatePdu &orig)
virtual	~DtArealObjectStatePdu ()
	destructor
DtArealObjectStatePdu &	operator= (const DtArealObjectStatePdu &orig)
	Assignment operator.
virtual void	setObjectID (const DtEntityIdentifier &id)
	Set/Get object ID.
virtual const DtEntityIdentifier &	objectID () const
virtual void	setReferencedObjectID (const DtEntityIdentifier &id)
	Set/Get referenced object ID.
virtual const DtEntityIdentifier &	referencedObjectID () const
virtual void	setUpdateNumber (DtU16 field)
	Set/Get update number.
virtual DtU16	updateNumber () const
virtual void	setForceID (DtForceType force)
	Set/Get the force ID.
virtual DtForceType	forceID () const
virtual void	setModifications (DtU8 value)
	Set/Get the modifications (by 8-bit integer).
virtual DtU8	modifications () const
virtual void	setModificationsField (DtModificationField field, bool value)
	Set/Get the modifications (by field).
virtual bool	modificationsField (DtModificationField field) const
virtual void	setObjectType (const DtSyntheticEnvironmentObjectType &type)
	Set/Get the object type.
virtual const DtSyntheticEnvironmentObjectType &	objectType () const
virtual void	setAppearance (DtU16 app)
	Set/Get appearance, the lower 16 bits (as an integer).
virtual DtU16	appearance () const
virtual void	setAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
	Set/Get appearance by attribute for the lower 16 bits.
virtual DtAppearAttrVal	appearanceAttribute (DtAppearAttribute attr) const
virtual void	setSpecificAppearance (DtU32 app)
	Set/Get specific appearance, the upper 32 bits (as a 32 bit integer).
virtual DtU32	specificAppearance () const
virtual void	setSpecificAppearanceAttribute (const DtAppearAttribute attr, const DtAppearAttrVal val)
	Set/Get specific appearance by attribute, the upper 32 bits.
virtual DtAppearAttrVal	specificAppearanceAttribute (const DtAppearAttribute attr) const
virtual bool	setNumPoints (DtU16 num)
	Set/Get the number of points.
virtual DtU16	numPoints () const
virtual void	setRequesterID (const DtSimulationAddress &type)
	Set/Get the requester ID.
virtual const DtSimulationAddress &	requesterID () const
virtual void	setReceivingID (const DtSimulationAddress &type)
	Set/Get the receiving ID.
virtual const DtSimulationAddress &	receivingID () const
virtual bool	setPointLocation (int index, const DtVector &init)
	Set/Get a point location. Returns false if the index is out of range.
virtual bool	getPointLocation (int index, DtVector &record) const
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
Public Member Functions inherited from DtStateMsg
	DtStateMsg ()
	default constructor
virtual	~DtStateMsg ()
	destructor
	DtStateMsg (const DtStateMsg &orig)
	copy constructor
DtStateMsg &	operator= (const DtStateMsg &orig)
	assignment operator
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtArealObjectStatePdu.
static void	addCallback (DtExerciseConn conn, DtArealObjectStatePduCb cb, void usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn conn, DtArealObjectStatePduCb cb, void usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetArealObjectStatePdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtArealObjectStatePdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtSyntheticEnvironmentObjectType	myObjectType
DtSimulationAddress	mySimulationAddress

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

Detailed Description

Instances of DtArealObjectStatePdu are used to communicate information about the addition/modification of a synthetic object which is geometrically anchored to the terrain with multiple points.

Constructor & Destructor Documentation

DtArealObjectStatePdu::DtArealObjectStatePdu ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtArealObjectStatePdu::DtArealObjectStatePdu	(	const DtNetArealObjectStatePdu *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

DtArealObjectStatePdu::DtArealObjectStatePdu ( const DtArealObjectStatePdu & orig )

virtual DtArealObjectStatePdu::~DtArealObjectStatePdu ( )

virtual

destructor

Member Function Documentation

static void DtArealObjectStatePdu::addCallback	(	DtExerciseConn *	conn,
		DtArealObjectStatePduCb	cb,
		void *	usr
	)

static

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual DtU16 DtArealObjectStatePdu::appearance ( ) const

virtual

virtual DtAppearAttrVal DtArealObjectStatePdu::appearanceAttribute ( DtAppearAttribute attr ) const

virtual

static DtPdu* DtArealObjectStatePdu::create	(	const DtNetPacket *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Create a DtArealObjectStatePdu.

Caller is responsible for deletion.

virtual DtForceType DtArealObjectStatePdu::forceID ( ) const

virtual

virtual bool DtArealObjectStatePdu::getPointLocation	(	int	index,
		DtVector &	record
	)		const

virtual

virtual DtPduKind DtArealObjectStatePdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtU8 DtArealObjectStatePdu::modifications ( ) const

virtual

virtual bool DtArealObjectStatePdu::modificationsField ( DtModificationField field ) const

virtual

virtual DtNetArealObjectStatePdu* DtArealObjectStatePdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU16 DtArealObjectStatePdu::numPoints ( ) const

virtual

virtual const DtEntityIdentifier& DtArealObjectStatePdu::objectID ( ) const

virtual

virtual const DtSyntheticEnvironmentObjectType& DtArealObjectStatePdu::objectType ( ) const

virtual

DtArealObjectStatePdu& DtArealObjectStatePdu::operator= ( const DtArealObjectStatePdu & orig )

Assignment operator.

virtual void DtArealObjectStatePdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtArealObjectStatePdu::printDataToStream ( std::ostream & stream ) const

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual const DtSimulationAddress& DtArealObjectStatePdu::receivingID ( ) const

virtual

virtual const DtEntityIdentifier& DtArealObjectStatePdu::referencedObjectID ( ) const

virtual

static void DtArealObjectStatePdu::removeCallback	(	DtExerciseConn *	conn,
		DtArealObjectStatePduCb	cb,
		void *	usr
	)

static

virtual const DtSimulationAddress& DtArealObjectStatePdu::requesterID ( ) const

virtual

DtArealObjectStatePdu* DtArealObjectStatePdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non-virtual since you can't override based on return type.

virtual void DtArealObjectStatePdu::setAppearance ( DtU16 app )

virtual

Set/Get appearance, the lower 16 bits (as an integer).

virtual void DtArealObjectStatePdu::setAppearanceAttribute	(	DtAppearAttribute	attr,
		DtAppearAttrVal	val
	)

virtual

Set/Get appearance by attribute for the lower 16 bits.

virtual void DtArealObjectStatePdu::setForceID ( DtForceType force )

virtual

Set/Get the force ID.

virtual void DtArealObjectStatePdu::setModifications ( DtU8 value )

virtual

Set/Get the modifications (by 8-bit integer).

virtual void DtArealObjectStatePdu::setModificationsField	(	DtModificationField	field,
		bool	value
	)

virtual

Set/Get the modifications (by field).

virtual bool DtArealObjectStatePdu::setNumPoints ( DtU16 num )

virtual

Set/Get the number of points.

virtual void DtArealObjectStatePdu::setObjectID ( const DtEntityIdentifier & id )

virtual

Set/Get object ID.

virtual void DtArealObjectStatePdu::setObjectType ( const DtSyntheticEnvironmentObjectType & type )

virtual

Set/Get the object type.

virtual bool DtArealObjectStatePdu::setPointLocation	(	int	index,
		const DtVector &	init
	)

virtual

Set/Get a point location. Returns false if the index is out of range.

virtual void DtArealObjectStatePdu::setReceivingID ( const DtSimulationAddress & type )

virtual

Set/Get the receiving ID.

virtual void DtArealObjectStatePdu::setReferencedObjectID ( const DtEntityIdentifier & id )

virtual

Set/Get referenced object ID.

virtual void DtArealObjectStatePdu::setRequesterID ( const DtSimulationAddress & type )

virtual

Set/Get the requester ID.

virtual void DtArealObjectStatePdu::setSpecificAppearance ( DtU32 app )

virtual

Set/Get specific appearance, the upper 32 bits (as a 32 bit integer).

virtual void DtArealObjectStatePdu::setSpecificAppearanceAttribute	(	const DtAppearAttribute	attr,
		const DtAppearAttrVal	val
	)

virtual

Set/Get specific appearance by attribute, the upper 32 bits.

virtual void DtArealObjectStatePdu::setUpdateNumber ( DtU16 field )

virtual

Set/Get update number.

virtual DtU32 DtArealObjectStatePdu::specificAppearance ( ) const

virtual

virtual DtAppearAttrVal DtArealObjectStatePdu::specificAppearanceAttribute ( const DtAppearAttribute attr ) const

virtual

virtual DtU16 DtArealObjectStatePdu::updateNumber ( ) const

virtual

virtual char* DtArealObjectStatePdu::var ( ) const

protectedvirtual

Returns a pointer to the first byte of variable length data.

Member Data Documentation

DtEntityIdentifier DtArealObjectStatePdu::myEntityID

protected

Temporary objects for reference returns.

DtSyntheticEnvironmentObjectType DtArealObjectStatePdu::myObjectType

protected

DtSimulationAddress DtArealObjectStatePdu::mySimulationAddress

protected

const int DtArealObjectStatePdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

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

arealObjStPdu.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation