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

This class provides a wrapper around the DIS Entity State PDU network structure. More...

+ Inheritance diagram for DtEntityStatePdu:
+ Collaboration diagram for DtEntityStatePdu:

List of all members.

Public Types

enum  { PduStaticSize = 144 }

Public Member Functions

 DtEntityStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtEntityStatePdu (const DtNetEntityStatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 CTOR for constructing the pdu using an existing net rep.
 DtEntityStatePdu (const DtEntityIdentifier &id, const DtEntityType &type, const DtEntityType &guise, DtDeadReckonTypes algorithm, DtForceType forceId, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 CTOR for creating a new Entity state pdu.
virtual ~DtEntityStatePdu ()
 DTOR.
const DtEntityIdentifier & id () const
void setId (const DtEntityIdentifier &id)
DtForceType forceId () const
void setForceId (DtForceType force)
int numArtParams () const
int numAttachedParams () const
int numArtPlusAttachedParams () const
const DtEntityType & entityType () const
void setEntityType (const DtEntityType &type)
const DtEntityType & guise () const
void setGuise (const DtEntityType &type)
const DtVector & velocity () const
void setVelocity (const DtVector &Velocity)
const DtVector & location () const
void setLocation (const DtVector &Location)
const DtTaitBryan & orientation () const
void setOrientation (const DtTaitBryan &Orient)
DtU32 appearance () const
 Get the appearance attribute collection.
void setAppearance (DtU32 app)
 Set the appearance attribute collection.
DtAppearAttrVal appearanceAttribute (const DtAppearAttribute &attr) const
 Get the value of a specific appearance attribute.
void setAppearanceAttribute (const DtAppearAttribute attr, const DtAppearAttrVal val)
 Set the value of a specific appearance attribute.
DtDeadReckonTypes algorithm () const
void setAlgorithm (DtDeadReckonTypes alg)
const DtVector & acceleration () const
void setAcceleration (const DtVector &Acceleration)
const DtVector & rotationalVelocity () const
void setRotationalVelocity (const DtVector &BodyRates)
int markingCharSet () const
void setMarkingText (const char *text)
const char * markingText () const
void setMarkingCharSet (int charSet)
DtU32 capabilities () const
void setCapabilities (DtU32 cap)
void setNumArtPlusAttachedParams (int num)
void printData () const
 Print the PDU's data (not including header).
void printDataToStream (std::ostream &stream) const
const DtArticulatedPartCollection & artPartList () const
 Set/Get the articulated part list via the DtArticulatedPartCollection.
void setArtPartList (const DtArticulatedPartCollection &apList)
 Set/Get the articulated part list via the DtArticulatedPartCollection.
const DtAttachedPartCollection & attPartList () const
 Set/Get the attached part list via the DtAttachedPartCollection.
void setAttPartList (const DtAttachedPartCollection &apList)
 Set/Get the attached part list via the DtAttachedPartCollection.
const DtNetArtPartRecord * artPartRecord (int index) const
 Access the net articulated parts records through an index.
DtNetArtPartRecord * artPartRecord (int index)
 Access the net articulated parts records through an index.
DtNetAttachedPart * attPartRecord (int index)
 Access the net attached parts records through an index.
const DtNetAttachedPart * attPartRecord (int index) const
 Access the net attached parts records through an index.

Static Public Member Functions

static DtPdu * create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Static functions.
static void addCallback (DtExerciseConn *conn, DtEntityStatePduCb cb, void *usr)
 Add a receive callback.
static void removeCallback (DtExerciseConn *conn, DtEntityStatePduCb cb, void *usr)
 Remove a receive callback.

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class.
DtNetArtPartRecord * artPartRecord (int partType, int param) const
DtNetArtPartRecord * attachedPartRecord (int station) const

Protected Attributes

DtEntityIdentifier myId
DtEntityType type
DtEntityType theGuise
DtVector vel
DtVector loc
DtVector acc
DtTaitBryan ori
DtBodyRates rvel
char markingBuff [DtMaxEntityMarkingLength+1]
DtArticulatedPartCollection myArtPartList
 Does not store state.
DtAttachedPartCollection myAttPartList
int myStationList [DtMaxNumAttachedParts]

Detailed Description

This class provides a wrapper around the DIS Entity State PDU network structure.


Member Enumeration Documentation

anonymous enum
Enumerator:
PduStaticSize 

Constructor & Destructor Documentation

CTOR for constructing the pdu using an existing net rep.

DtEntityStatePdu::DtEntityStatePdu ( const DtEntityIdentifier &  id,
const DtEntityType &  type,
const DtEntityType &  guise,
DtDeadReckonTypes  algorithm,
DtForceType  forceId,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

CTOR for creating a new Entity state pdu.

virtual DtEntityStatePdu::~DtEntityStatePdu ( ) [inline, virtual]

DTOR.


Member Function Documentation

static void DtEntityStatePdu::addCallback ( DtExerciseConn *  conn,
DtEntityStatePduCb  cb,
void *  usr 
) [static]

Add a receive callback.

Get the appearance attribute collection.

Get the value of a specific appearance attribute.

Set/Get the articulated part list via the DtArticulatedPartCollection.

Warning:
setNumArtPlusAttachedParams() needs to be called before setting the articulated parts, as memory needs to be allocated

Access the net articulated parts records through an index.

These are used for encoding/decoding functions. It is recommended that the artPartList() accessor is used for articulated part access from the PDU.

Access the net articulated parts records through an index.

These are used for encoding/decoding functions. It is recommended that the artPartList() accessor is used for articulated part access from the PDU.

DtNetArtPartRecord* DtEntityStatePdu::artPartRecord ( int  partType,
int  param 
) const [protected]
DtNetArtPartRecord* DtEntityStatePdu::attachedPartRecord ( int  station) const [protected]

Set/Get the attached part list via the DtAttachedPartCollection.

Warning:
setNumArtPlusAttachedParams() needs to be called before setting the articulated parts, as memory needs to be allocated

Access the net attached parts records through an index.

These are used for encoding/decoding functions. It is recommended that the attPartList() accessor is used for articulated part access from the PDU.

Access the net attached parts records through an index.

These are used for encoding/decoding functions. It is recommended that the attPartList() accessor is used for articulated part access from the PDU.

static DtPdu* DtEntityStatePdu::create ( const DtNetPacket *  initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Static functions.

DtPduKind DtEntityStatePdu::internalGetPduKind ( ) const [inline, protected, virtual]

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtEntityStatePduKind.

const char* DtEntityStatePdu::markingText ( ) const
void DtEntityStatePdu::printData ( ) const [virtual]

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

void DtEntityStatePdu::printDataToStream ( std::ostream &  stream) const [virtual]

Reimplemented from DtPdu.

static void DtEntityStatePdu::removeCallback ( DtExerciseConn *  conn,
DtEntityStatePduCb  cb,
void *  usr 
) [static]

Remove a receive callback.

void DtEntityStatePdu::setAcceleration ( const DtVector &  Acceleration)

Set the appearance attribute collection.

Set the value of a specific appearance attribute.

Set/Get the articulated part list via the DtArticulatedPartCollection.

Warning:
setNumArtPlusAttachedParams() needs to be called before setting the articulated parts, as memory needs to be allocated

Set/Get the attached part list via the DtAttachedPartCollection.

Warning:
setNumArtPlusAttachedParams() needs to be called before setting the articulated parts, as memory needs to be allocated
void DtEntityStatePdu::setGuise ( const DtEntityType &  type)
void DtEntityStatePdu::setLocation ( const DtVector &  Location)
void DtEntityStatePdu::setMarkingCharSet ( int  charSet)
void DtEntityStatePdu::setMarkingText ( const char *  text)
void DtEntityStatePdu::setVelocity ( const DtVector &  Velocity)

Member Data Documentation

Does not store state.


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)