 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
Instances of DtLeTspiPdu are used to send state information for live entities. More...
Inheritance diagram for DtLeTspiPdu: Collaboration diagram for DtLeTspiPdu:Public Member Functions | |
| DtLeTspiPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtLeTspiPdu (const DtNetLeTspiPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| DtLeTspiPdu (const DtLeTspiPdu &orig) | |
| virtual | ~DtLeTspiPdu () |
| destructor | |
| DtLeTspiPdu & | operator= (const DtLeTspiPdu &orig) |
| Assignment operator. | |
| virtual void | setSubProtocol (DtSubProtocol value) |
| Set/Get the sub-protocol number. | |
| virtual DtSubProtocol | subProtocol () const |
| virtual void | setEntityID (const DtLeEntityID &id) |
| Set/Get entity ID. | |
| virtual const DtLeEntityID & | entityID () const |
| virtual DtU8 | tspiField () const |
| Get TSPI Flag field (this field is automatically maintained by the PDU as other PDU fields are set). | |
| virtual bool | tspiFlag (DtLE_TSPI_FieldFlag flag) const |
| Get the value for a specific TSPI flag from the flag field. | |
| virtual void | setLocation (const DtLeEntityLocationWorldCoordinates &value) |
| Set/Get entity location. | |
| virtual const DtLeEntityLocationWorldCoordinates & | location () const |
| virtual void | setVelocity (const DtLeEntityLinearVelocity &value) |
| The following accessor functions refer to records which are optional. | |
| virtual bool | getVelocity (DtLeEntityLinearVelocity &value) const |
| virtual void | setOrientation (const DtLeEntityOrientation &value) |
| Set/Get entity orientation. | |
| virtual bool | getOrientation (DtLeEntityOrientation &value) const |
| virtual void | setPositionError (const DtLePositionError &value) |
| Set/Get position error. | |
| virtual bool | getPositionError (DtLePositionError &value) const |
| virtual void | setOrientationError (const DtLeOrientationError &value) |
| Set/Get orientation error. | |
| virtual bool | getOrientationError (DtLeOrientationError &value) const |
| virtual void | setDeadReckoningParameters (const DtLeDeadReckoningParameters &value) |
| Set/Get dead reckoning parameters. | |
| virtual bool | getDeadReckoningParameters (DtLeDeadReckoningParameters &value) const |
| virtual void | setMeasuredSpeed (DtU16 value) |
| Set/Get measured speed. | |
| virtual bool | getMeasuredSpeed (DtU16 &value) const |
| virtual bool | setSystemSpecificDataLength (DtU8 value) |
| Set/Get the system specific data length. | |
| virtual DtU8 | systemSpecificDataLength () const |
| virtual bool | setSystemSpecificData (DtU8 *dataPtr) |
| Set/Get the system specific data (will copy systemSpecificDataLength() bytes on set/get). | |
| virtual bool | getSystemSpecificData (DtU8 *dataPtr) |
| virtual void | printData () const |
| Print the data contained by this PDU. | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print the data to a stream. | |
| virtual void | printHeader () const |
| Print the header (override to include the new sub-protocol field). | |
| virtual void | printHeaderToStream (std::ostream &stream) const |
| Print the header to a stream. | |
Static Public Member Functions | |
| static DtPdu * | create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Create a DtLeTspiPdu. | |
| static void | addCallback (DtExerciseConn *conn, DtLeTspiPduCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. | |
| static void | removeCallback (DtExerciseConn *conn, DtLeTspiPduCb cb, void *usr) |
Protected Member Functions | |
| virtual DtPduKind | internalGetPduKind () const |
| Returns the internal PDU kind. | |
| virtual DtNetLeTspiPdu * | netPduStruct () const |
| Casts the netPdu element to our network struct. | |
| DtLeTspiPdu * | 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. | |
| virtual void | setTspiField (DtU8 value) |
| Set TSPI Flags. | |
| virtual void | setTspiFlag (DtLE_TSPI_FieldFlag flag) |
| Set a flag of the TSPI field. | |
| virtual void | clearTspiFlags (DtLE_TSPI_FieldFlag flag) |
| Clear the flag and all following flags in the TSPI field. | |
| virtual int | tspiFlagOffset () const |
| Returns the offset (in bytes) of a field from variable data region. | |
| virtual int | locationOffset () const |
| virtual int | velocityOffset () const |
| virtual int | orientationOffset () const |
| virtual int | positionErrorOffset () const |
| virtual int | orientationErrorOffset () const |
| virtual int | deadReckoningParametersOffset () const |
| virtual int | measuredSpeedOffset () const |
| virtual int | systemSpecificOffset () const |
Protected Attributes | |
| DtLeEntityID | myEntityID |
| Temporary objects for reference returns. | |
| DtLeEntityLocationWorldCoordinates | myLocation |
Static Protected Attributes | |
| static const int | theStaticSize |
| Size of PDU with zero parameter records. | |
Instances of DtLeTspiPdu are used to send state information for live entities.
| DtLeTspiPdu::DtLeTspiPdu | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
| DtLeTspiPdu::DtLeTspiPdu | ( | const DtNetLeTspiPdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
| DtLeTspiPdu::DtLeTspiPdu | ( | const DtLeTspiPdu & | orig | ) |
| virtual DtLeTspiPdu::~DtLeTspiPdu | ( | ) | [virtual] |
destructor
| static void DtLeTspiPdu::addCallback | ( | DtExerciseConn * | conn, |
| DtLeTspiPduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Add (register)/Remove (deregister) function to be called when pdu is received.
| virtual void DtLeTspiPdu::clearTspiFlags | ( | DtLE_TSPI_FieldFlag | flag | ) | [protected, virtual] |
Clear the flag and all following flags in the TSPI field.
| static DtPdu* DtLeTspiPdu::create | ( | const DtNetPacket * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Create a DtLeTspiPdu.
Caller is responsible for deletion.
| virtual int DtLeTspiPdu::deadReckoningParametersOffset | ( | ) | const [protected, virtual] |
| virtual const DtLeEntityID& DtLeTspiPdu::entityID | ( | ) | const [virtual] |
| virtual bool DtLeTspiPdu::getDeadReckoningParameters | ( | DtLeDeadReckoningParameters & | value | ) | const [virtual] |
| virtual bool DtLeTspiPdu::getMeasuredSpeed | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeTspiPdu::getOrientation | ( | DtLeEntityOrientation & | value | ) | const [virtual] |
| virtual bool DtLeTspiPdu::getOrientationError | ( | DtLeOrientationError & | value | ) | const [virtual] |
| virtual bool DtLeTspiPdu::getPositionError | ( | DtLePositionError & | value | ) | const [virtual] |
| virtual bool DtLeTspiPdu::getSystemSpecificData | ( | DtU8 * | dataPtr | ) | [virtual] |
| virtual bool DtLeTspiPdu::getVelocity | ( | DtLeEntityLinearVelocity & | value | ) | const [virtual] |
| virtual DtPduKind DtLeTspiPdu::internalGetPduKind | ( | ) | const [protected, virtual] |
Returns the internal PDU kind.
Implements DtPdu.
| virtual const DtLeEntityLocationWorldCoordinates& DtLeTspiPdu::location | ( | ) | const [virtual] |
| virtual int DtLeTspiPdu::locationOffset | ( | ) | const [protected, virtual] |
| virtual int DtLeTspiPdu::measuredSpeedOffset | ( | ) | const [protected, virtual] |
| virtual DtNetLeTspiPdu* DtLeTspiPdu::netPduStruct | ( | ) | const [protected, virtual] |
Casts the netPdu element to our network struct.
| DtLeTspiPdu& DtLeTspiPdu::operator= | ( | const DtLeTspiPdu & | orig | ) |
Assignment operator.
| virtual int DtLeTspiPdu::orientationErrorOffset | ( | ) | const [protected, virtual] |
| virtual int DtLeTspiPdu::orientationOffset | ( | ) | const [protected, virtual] |
| virtual int DtLeTspiPdu::positionErrorOffset | ( | ) | const [protected, virtual] |
| virtual void DtLeTspiPdu::printData | ( | ) | const [virtual] |
Print the data contained by this PDU.
Reimplemented from DtPdu.
| virtual void DtLeTspiPdu::printDataToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the data to a stream.
Reimplemented from DtPdu.
| virtual void DtLeTspiPdu::printHeader | ( | ) | const [virtual] |
Print the header (override to include the new sub-protocol field).
Reimplemented from DtPdu.
| virtual void DtLeTspiPdu::printHeaderToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the header to a stream.
Reimplemented from DtPdu.
| static void DtLeTspiPdu::removeCallback | ( | DtExerciseConn * | conn, |
| DtLeTspiPduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
| DtLeTspiPdu* DtLeTspiPdu::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 DtLeTspiPdu::setDeadReckoningParameters | ( | const DtLeDeadReckoningParameters & | value | ) | [virtual] |
Set/Get dead reckoning parameters.
| virtual void DtLeTspiPdu::setEntityID | ( | const DtLeEntityID & | id | ) | [virtual] |
Set/Get entity ID.
| virtual void DtLeTspiPdu::setLocation | ( | const DtLeEntityLocationWorldCoordinates & | value | ) | [virtual] |
Set/Get entity location.
| virtual void DtLeTspiPdu::setMeasuredSpeed | ( | DtU16 | value | ) | [virtual] |
Set/Get measured speed.
| virtual void DtLeTspiPdu::setOrientation | ( | const DtLeEntityOrientation & | value | ) | [virtual] |
Set/Get entity orientation.
| virtual void DtLeTspiPdu::setOrientationError | ( | const DtLeOrientationError & | value | ) | [virtual] |
Set/Get orientation error.
| virtual void DtLeTspiPdu::setPositionError | ( | const DtLePositionError & | value | ) | [virtual] |
Set/Get position error.
| virtual void DtLeTspiPdu::setSubProtocol | ( | DtSubProtocol | value | ) | [virtual] |
Set/Get the sub-protocol number.
| virtual bool DtLeTspiPdu::setSystemSpecificData | ( | DtU8 * | dataPtr | ) | [virtual] |
Set/Get the system specific data (will copy systemSpecificDataLength() bytes on set/get).
Returns false if the length is zero.
| virtual bool DtLeTspiPdu::setSystemSpecificDataLength | ( | DtU8 | value | ) | [virtual] |
Set/Get the system specific data length.
| virtual void DtLeTspiPdu::setTspiField | ( | DtU8 | value | ) | [protected, virtual] |
Set TSPI Flags.
| virtual void DtLeTspiPdu::setTspiFlag | ( | DtLE_TSPI_FieldFlag | flag | ) | [protected, virtual] |
Set a flag of the TSPI field.
| virtual void DtLeTspiPdu::setVelocity | ( | const DtLeEntityLinearVelocity & | value | ) | [virtual] |
The following accessor functions refer to records which are optional.
The set methods create the record in the PDU if it does not already exist. The get methods return false if the record does not exist. Set/Get entity linear velocity.
| virtual DtSubProtocol DtLeTspiPdu::subProtocol | ( | ) | const [virtual] |
| virtual DtU8 DtLeTspiPdu::systemSpecificDataLength | ( | ) | const [virtual] |
| virtual int DtLeTspiPdu::systemSpecificOffset | ( | ) | const [protected, virtual] |
| virtual DtU8 DtLeTspiPdu::tspiField | ( | ) | const [virtual] |
Get TSPI Flag field (this field is automatically maintained by the PDU as other PDU fields are set).
| virtual bool DtLeTspiPdu::tspiFlag | ( | DtLE_TSPI_FieldFlag | flag | ) | const [virtual] |
Get the value for a specific TSPI flag from the flag field.
| virtual int DtLeTspiPdu::tspiFlagOffset | ( | ) | const [protected, virtual] |
Returns the offset (in bytes) of a field from variable data region.
| virtual char* DtLeTspiPdu::var | ( | ) | const [protected, virtual] |
Returns a pointer to the first byte of variable length data.
| virtual int DtLeTspiPdu::velocityOffset | ( | ) | const [protected, virtual] |
DtLeEntityID DtLeTspiPdu::myEntityID [protected] |
Temporary objects for reference returns.
const int DtLeTspiPdu::theStaticSize [static, protected] |
Size of PDU with zero parameter records.
