VR-Link API Documentation for DIS
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtPointObjectStatePdu Class Reference

class DtPointObjectStatePdu: More...

+ Inheritance diagram for DtPointObjectStatePdu:
+ Collaboration diagram for DtPointObjectStatePdu:

List of all members.

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
DtPointObjectStatePduoperator= (const DtPointObjectStatePdu &orig)
 Assignment operator.
virtual void setObjectID (const DtEntityIdentifier &id)
 Set/Get object ID.
virtual const DtEntityIdentifierobjectID () const
virtual void setReferencedObjectID (const DtEntityIdentifier &id)
 Set/Get referenced object ID.
virtual const DtEntityIdentifierreferencedObjectID () 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 DtVectorlocation () const
virtual void setOrientation (const DtTaitBryan &orientation)
 Set/Get orientation.
virtual const DtTaitBryanorientation () 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 DtSimulationAddressrequesterID () const
virtual void setReceivingID (const DtSimulationAddress &type)
 Set/Get the receiving ID.
virtual const DtSimulationAddressreceivingID () 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.

Static Public Member Functions

static DtPducreate (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 DtNetPointObjectStatePdunetPduStruct () const
 Casts the netPdu element to our network struct.
DtPointObjectStatePduself () 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

Constructors.

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]
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 [protected, virtual]

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 [protected, virtual]

Casts the netPdu element to our network struct.

virtual const DtEntityIdentifier& DtPointObjectStatePdu::objectID ( ) 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]
static void DtPointObjectStatePdu::removeCallback ( DtExerciseConn conn,
DtPointObjectStatePduCb  cb,
void *  usr 
) [static]
virtual const DtSimulationAddress& DtPointObjectStatePdu::requesterID ( ) const [virtual]

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

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.

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 DtU16 DtPointObjectStatePdu::updateNumber ( ) const [virtual]

Member Data Documentation

Temporary objects for reference returns.

const int DtPointObjectStatePdu::theStaticSize [static, protected]

Size of PDU with zero parameter records.


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)