DtPointObjectStatePdu Class Reference

class DtPointObjectStatePdu: More...

Inheritance diagram for DtPointObjectStatePdu:

Collaboration diagram for DtPointObjectStatePdu:

Public Member Functions
	DtPointObjectStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtPointObjectStatePdu (const DtNetPointObjectStatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtPointObjectStatePdu (const DtPointObjectStatePdu &orig)
virtual	~DtPointObjectStatePdu ()
	destructor
DtPointObjectStatePdu &	operator= (const DtPointObjectStatePdu &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	setLocation (const DtVector &coords)
	Set/Get location.
virtual const DtVector &	location () const
virtual void	setOrientation (const DtTaitBryan &orientation)
	Set/Get orientation.
virtual const DtTaitBryan &	orientation () 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 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 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 DtPointObjectStatePdu.
static void	addCallback (DtExerciseConn *conn, DtPointObjectStatePduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtPointObjectStatePduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetPointObjectStatePdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtPointObjectStatePdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtSyntheticEnvironmentObjectType	myObjectType
DtVector	myVector
DtTaitBryan	myEulerAngles
DtSimulationAddress	mySimulationAddress

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

Detailed Description

class DtPointObjectStatePdu:

Instances of DtPointObjectStatePdu are used to state information for synthetic environment objects.

Constructor & Destructor Documentation

DtPointObjectStatePdu::DtPointObjectStatePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtPointObjectStatePdu::DtPointObjectStatePdu	(	const DtNetPointObjectStatePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtPointObjectStatePdu::DtPointObjectStatePdu

(

const DtPointObjectStatePdu &

orig

)

virtual DtPointObjectStatePdu::~DtPointObjectStatePdu ( )

virtual

destructor

Member Function Documentation

static void DtPointObjectStatePdu::addCallback ( DtExerciseConn *  conn, DtPointObjectStatePduCb  cb, void *  usr  )

static

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

virtual DtU16 DtPointObjectStatePdu::appearance ( ) const

virtual

virtual DtAppearAttrVal DtPointObjectStatePdu::appearanceAttribute ( DtAppearAttribute  attr ) const

virtual

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

static

Create a DtPointObjectStatePdu.

Caller is responsible for deletion.

virtual DtForceType DtPointObjectStatePdu::forceID ( ) const

virtual

virtual DtPduKind DtPointObjectStatePdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtVector& DtPointObjectStatePdu::location ( ) const

virtual

virtual DtU8 DtPointObjectStatePdu::modifications ( ) const

virtual

virtual bool DtPointObjectStatePdu::modificationsField ( DtModificationField  field ) const

virtual

virtual DtNetPointObjectStatePdu* DtPointObjectStatePdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual const DtEntityIdentifier& DtPointObjectStatePdu::objectID ( ) const

virtual

virtual const DtSyntheticEnvironmentObjectType& DtPointObjectStatePdu::objectType ( ) const

virtual

DtPointObjectStatePdu& DtPointObjectStatePdu::operator=

(

const DtPointObjectStatePdu &

orig

)

Assignment operator.

virtual const DtTaitBryan& DtPointObjectStatePdu::orientation ( ) const

virtual

virtual void DtPointObjectStatePdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual const DtSimulationAddress& DtPointObjectStatePdu::receivingID ( ) const

virtual

virtual const DtEntityIdentifier& DtPointObjectStatePdu::referencedObjectID ( ) const

virtual

static void DtPointObjectStatePdu::removeCallback ( DtExerciseConn *  conn, DtPointObjectStatePduCb  cb, void *  usr  )

static

virtual const DtSimulationAddress& DtPointObjectStatePdu::requesterID ( ) const

virtual

DtPointObjectStatePdu* DtPointObjectStatePdu::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 DtPointObjectStatePdu::setAppearance ( DtU16  app )

virtual

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

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

virtual

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

virtual void DtPointObjectStatePdu::setForceID ( DtForceType  force )

virtual

Set/Get the force ID.

virtual void DtPointObjectStatePdu::setLocation ( const DtVector &  coords )

virtual

Set/Get location.

virtual void DtPointObjectStatePdu::setModifications ( DtU8  value )

virtual

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

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

virtual

Set/Get the modifications (by field).

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

virtual

Set/Get object ID.

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

virtual

Set/Get the object type.

virtual void DtPointObjectStatePdu::setOrientation ( const DtTaitBryan &  orientation )

virtual

Set/Get orientation.

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

virtual

Set/Get the receiving ID.

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

virtual

Set/Get referenced object ID.

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

virtual

Set/Get the requester ID.

virtual void DtPointObjectStatePdu::setSpecificAppearance ( DtU32  app )

virtual

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

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

virtual

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

virtual void DtPointObjectStatePdu::setUpdateNumber ( DtU16  field )

virtual

Set/Get update number.

virtual DtU32 DtPointObjectStatePdu::specificAppearance ( ) const

virtual

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

virtual

virtual DtU16 DtPointObjectStatePdu::updateNumber ( ) const

virtual

Member Data Documentation

DtEntityIdentifier DtPointObjectStatePdu::myEntityID

protected

Temporary objects for reference returns.

DtTaitBryan DtPointObjectStatePdu::myEulerAngles

protected

DtSyntheticEnvironmentObjectType DtPointObjectStatePdu::myObjectType

protected

DtSimulationAddress DtPointObjectStatePdu::mySimulationAddress

protected

DtVector DtPointObjectStatePdu::myVector

protected

const int DtPointObjectStatePdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• pointObjStPdu.h