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

Instances of DtDesignatorPduare used to communicate information about designator objects in DIS. More...

+ Inheritance diagram for DtDesignatorPdu:
+ Collaboration diagram for DtDesignatorPdu:

List of all members.

Public Types

enum  { DtDesignatorStaticSizeVERS5 = 88, DtDesignatorStaticSizeVERS4 = 72 }
 Enumerator to describe the size of PDU's across DIS versions. More...
enum  { PduStaticSize = DtDesignatorStaticSizeVERS5 }
 Static size is defaulted to DIS version 5. More...

Public Member Functions

 DtDesignatorPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Default constructor.
 DtDesignatorPdu (const DtNetDesignatorPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor that takes a net packet.
virtual void printData () const
 Prints the PDU's data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Prints the PDU's data to the specified stream.
const DtEntityIdentifierdesignatingEntityId () const
 Get/Set the entity ID of the entity that the designator is attached to.
void setDesignatingEntityId (const DtEntityIdentifier &id)
 Get/Set the entity ID of the entity that the designator is attached to.
DtDesignatorCodeName codeName () const
 Get/Set the designator code name.
void setCodeName (DtDesignatorCodeName name)
 Get/Set the designator code name.
const DtEntityIdentifierdesignatedEntityId () const
 Get/Set the designated entity ID.
void setDesignatedEntityId (const DtEntityIdentifier &id)
 Get/Set the designated entity ID.
DtDesignatorCode designatorCode () const
 Get/Set the designator code.
void setDesignatorCode (DtDesignatorCode code)
 Get/Set the designator code.
float power () const
 Get/Set the designator power.
void setPower (float power)
 Get/Set the designator power.
float wavelength () const
 Get/Set the designator wavelength.
void setWavelength (float wavelength)
 Get/Set the designator wavelength.
const DtVectordesignatorSpotRelative () const
 Get/Set the designator spot with respect to the designated entity.
void setDesignatorSpotRelative (const DtVector &loc)
 Get/Set the designator spot with respect to the designated entity.
const DtVectordesignatorSpotWorld () const
 Get/Set the designator spot location.
void setDesignatorSpotWorld (const DtVector &loc)
 Get/Set the designator spot location.
DtDeadReckonTypes deadReckoningAlgorithm () const
 Get/Set the dead reckoning algorithm.
void setDeadReckoningAlgorithm (DtDeadReckonTypes alg)
 Get/Set the dead reckoning algorithm.
const DtVectorlinearAcceleration () const
 Get/Set the designator spot's linear acceleration.
void setLinearAcceleration (const DtVector &acc)
 Get/Set the designator spot's linear acceleration.

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator method that takes a net packet and creates a DtDesignatorPdu.
static void addCallback (DtExerciseConn *conn, DtDesignatorPduCb cb, void *usr)
 Register a callback on the receipt of a Designator PDU.
static void removeCallback (DtExerciseConn *conn, DtDesignatorPduCb cb, void *usr)
 Remove a callback registered using addCallback().

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class.

Protected Attributes

DtEntityIdentifier theId
DtVector loc

Detailed Description

Instances of DtDesignatorPduare used to communicate information about designator objects in DIS.


Member Enumeration Documentation

anonymous enum

Enumerator to describe the size of PDU's across DIS versions.

Enumerator:
DtDesignatorStaticSizeVERS5 
DtDesignatorStaticSizeVERS4 
anonymous enum

Static size is defaulted to DIS version 5.

Enumerator:
PduStaticSize 

Constructor & Destructor Documentation

Default constructor.

Constructor that takes a net packet.


Member Function Documentation

static void DtDesignatorPdu::addCallback ( DtExerciseConn conn,
DtDesignatorPduCb  cb,
void *  usr 
) [static]

Register a callback on the receipt of a Designator PDU.

Get/Set the designator code name.

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

Creator method that takes a net packet and creates a DtDesignatorPdu.

Get/Set the dead reckoning algorithm.

Get/Set the designated entity ID.

Get/Set the entity ID of the entity that the designator is attached to.

Get/Set the designator code.

Get/Set the designator spot with respect to the designated entity.

Get/Set the designator spot location.

This takes a world coordinate location.

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

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtDesignatorPduKind.

Get/Set the designator spot's linear acceleration.

float DtDesignatorPdu::power ( ) const

Get/Set the designator power.

virtual void DtDesignatorPdu::printData ( ) const [virtual]

Prints the PDU's data to DtInfo.

Reimplemented from DtPdu.

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

Prints the PDU's data to the specified stream.

Reimplemented from DtPdu.

static void DtDesignatorPdu::removeCallback ( DtExerciseConn conn,
DtDesignatorPduCb  cb,
void *  usr 
) [static]

Remove a callback registered using addCallback().

Get/Set the designator code name.

Get/Set the dead reckoning algorithm.

Get/Set the designated entity ID.

Get/Set the entity ID of the entity that the designator is attached to.

Get/Set the designator code.

Get/Set the designator spot with respect to the designated entity.

Get/Set the designator spot location.

This takes a world coordinate location.

Get/Set the designator spot's linear acceleration.

void DtDesignatorPdu::setPower ( float  power)

Get/Set the designator power.

void DtDesignatorPdu::setWavelength ( float  wavelength)

Get/Set the designator wavelength.

float DtDesignatorPdu::wavelength ( ) const

Get/Set the designator wavelength.


Member Data Documentation


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)