 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
Instances of DtLeDetonationPdu are used to send firing information for live entities. More...
Inheritance diagram for DtLeDetonationPdu: Collaboration diagram for DtLeDetonationPdu:Public Member Functions | |
| DtLeDetonationPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtLeDetonationPdu (const DtNetLeDetonationPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| DtLeDetonationPdu (const DtLeDetonationPdu &orig) | |
| virtual | ~DtLeDetonationPdu () |
| destructor | |
| DtLeDetonationPdu & | operator= (const DtLeDetonationPdu &orig) |
| Assignment operator. | |
| virtual void | setSubProtocol (DtSubProtocol value) |
| Set/Get the sub-protocol number. | |
| virtual DtSubProtocol | subProtocol () const |
| virtual void | setFiringEntityID (const DtLeEntityID &id) |
| Set/Get firing entity ID. | |
| virtual const DtLeEntityID & | firingEntityID () const |
| virtual DtU8 | detonFlagsField () const |
| Get flags field 1 (this field is automatically maintained by the PDU as other PDU fields are set). | |
| virtual bool | getDeton2FlagsField (DtU8 &field) const |
| Get flags field 2 (this field is automatically maintained by the PDU as other PDU fields are set). | |
| virtual bool | detonFlag (DtLE_DetonFieldFlag flag) const |
| Get the value for a specific flag from the first flags field. | |
| virtual bool | getDeton2Flag (DtLE_DetonField2Flag flag, bool &value) const |
| Get the value for a specific flag from the second flags field. | |
| virtual void | setTargetEntityID (const DtLeEntityID &id) |
| Some of following accessor functions refer to records which are optional. | |
| virtual bool | getTargetEntityID (DtLeEntityID &id) const |
| virtual void | setMunitionID_Site (DtU8 value) |
| Set/Get munition ID site (optional). | |
| virtual bool | getMunitionID_Site (DtU8 &value) const |
| virtual void | setMunitionID_Application (DtU8 value) |
| Set/Get munition ID application (optional). | |
| virtual bool | getMunitionID_Application (DtU8 &value) const |
| virtual void | setMunitionID_Entity (DtU16 value) |
| Set/Get munition ID entity (optional) | |
| virtual bool | getMunitionID_Entity (DtU16 &value) const |
| virtual void | setEventID_Site (DtU8 value) |
| Set/Get event ID site (optional). | |
| virtual bool | getEventID_Site (DtU8 &value) const |
| virtual void | setEventID_Application (DtU8 value) |
| Set/Get event ID application (optional). | |
| virtual bool | getEventID_Application (DtU8 &value) const |
| virtual void | setEventID_Event (DtU16 value) |
| Set/Get event ID event. | |
| virtual bool | getEventID_Event (DtU16 &value) const |
| virtual void | setLocationWorld (const DtLeEntityLocationWorldCoordinates &value) |
| Set/Get entity location (world coordinates). | |
| virtual bool | getLocationWorld (DtLeEntityLocationWorldCoordinates &value) const |
| virtual void | setLocationEntity (const DtLeEntityLocationEntityCoordinates &value) |
| Set/Get entity location (entity coordinates). | |
| virtual bool | getLocationEntity (DtLeEntityLocationEntityCoordinates &value) const |
| virtual void | setVelocity (const DtLeEntityLinearVelocity &value) |
| Set/Get entity linear velocity. | |
| virtual const DtLeEntityLinearVelocity & | velocity () const |
| virtual void | setOrientation (const DtLeEntityOrientation &value) |
| Set/Get entity orientation. | |
| virtual bool | getOrientation (DtLeEntityOrientation &value) const |
| virtual void | setBurstMunitionType (DtEntityType &type) |
| Set/Get burst munition type. | |
| virtual const DtEntityType & | burstMunitionType () const |
| virtual void | setBurstWarhead (DtU16 value) |
| Set/Get burst warhead (optional). | |
| virtual bool | getBurstWarhead (DtU16 &value) const |
| virtual void | setBurstFuse (DtU16 value) |
| Set/Get burst fuse (optional). | |
| virtual bool | getBurstFuse (DtU16 &value) const |
| virtual void | setBurstQuantity (DtU16 value) |
| Set/Get burst quantity (optional). | |
| virtual bool | getBurstQuantity (DtU16 &value) const |
| virtual void | setBurstRate (DtU16 value) |
| Set/Get burst rate (optional). | |
| virtual bool | getBurstRate (DtU16 &value) const |
| virtual void | setDetonationResult (DtU8 value) |
| Set/Get detonation result. | |
| virtual DtU8 | detonationResult () 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. | |
| 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 DtLeDetonationPdu. | |
| static void | addCallback (DtExerciseConn *conn, DtLeDetonationPduCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. | |
| static void | removeCallback (DtExerciseConn *conn, DtLeDetonationPduCb cb, void *usr) |
Protected Member Functions | |
| virtual DtPduKind | internalGetPduKind () const |
| Returns the internal PDU kind. | |
| virtual DtNetLeDetonationPdu * | netPduStruct () const |
| Casts the netPdu element to our network struct. | |
| DtLeDetonationPdu * | 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 | setDetonFlagsField (DtU8 value) |
| Set first detonation flags field. | |
| virtual void | setDeton2FlagsField (DtU8 value) |
| Set second detonation flags field. | |
| virtual void | setDetonFlag (DtLE_DetonFieldFlag flag) |
| Set first detonation flag. | |
| virtual void | setDeton2Flag (DtLE_DetonField2Flag flag) |
| Set second detonation flag. | |
| virtual int | detonFlagFieldOffset () const |
| Returns the offset (in bytes) of a field within the variable data region. | |
| virtual int | deton2FlagFieldOffset () const |
| virtual int | targetEntityID_Offset () const |
| virtual int | munitionID_Offset1 () const |
| virtual int | munitionID_Offset2 () const |
| virtual int | eventID_Offset1 () const |
| virtual int | eventID_Offset2 () const |
| virtual int | locationWorldOffset () const |
| virtual int | velocityOffset () const |
| virtual int | munitionOrientationOffset () const |
| virtual int | burstOffset1 () const |
| virtual int | burstOffset2 () const |
| virtual int | burstOffset3 () const |
| virtual int | locationEntityOffset () const |
| virtual int | resultOffset () const |
Protected Attributes | |
| DtLeEntityID | myEntityID |
| Temporary objects for reference returns. | |
| DtLeEntityLinearVelocity | myVelocity |
| DtEntityType | myEntityType |
Static Protected Attributes | |
| static const int | theStaticSize |
| Size of PDU with zero parameter records. | |
Instances of DtLeDetonationPdu are used to send firing information for live entities.
Constructors.
| DtLeDetonationPdu::DtLeDetonationPdu | ( | const DtNetLeDetonationPdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
| DtLeDetonationPdu::DtLeDetonationPdu | ( | const DtLeDetonationPdu & | orig | ) |
| virtual DtLeDetonationPdu::~DtLeDetonationPdu | ( | ) | [virtual] |
destructor
| static void DtLeDetonationPdu::addCallback | ( | DtExerciseConn * | conn, |
| DtLeDetonationPduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Add (register)/Remove (deregister) function to be called when pdu is received.
| virtual const DtEntityType& DtLeDetonationPdu::burstMunitionType | ( | ) | const [virtual] |
| virtual int DtLeDetonationPdu::burstOffset1 | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::burstOffset2 | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::burstOffset3 | ( | ) | const [protected, virtual] |
| static DtPdu* DtLeDetonationPdu::create | ( | const DtNetPacket * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Create a DtLeDetonationPdu.
Caller is responsible for deletion.
| virtual int DtLeDetonationPdu::deton2FlagFieldOffset | ( | ) | const [protected, virtual] |
| virtual DtU8 DtLeDetonationPdu::detonationResult | ( | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::detonFlag | ( | DtLE_DetonFieldFlag | flag | ) | const [virtual] |
Get the value for a specific flag from the first flags field.
| virtual int DtLeDetonationPdu::detonFlagFieldOffset | ( | ) | const [protected, virtual] |
Returns the offset (in bytes) of a field within the variable data region.
Some fields have subfields which are optional, so some fields have multiple functions associated with them.
| virtual DtU8 DtLeDetonationPdu::detonFlagsField | ( | ) | const [virtual] |
Get flags field 1 (this field is automatically maintained by the PDU as other PDU fields are set).
| virtual int DtLeDetonationPdu::eventID_Offset1 | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::eventID_Offset2 | ( | ) | const [protected, virtual] |
| virtual const DtLeEntityID& DtLeDetonationPdu::firingEntityID | ( | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getBurstFuse | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getBurstQuantity | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getBurstRate | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getBurstWarhead | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getDeton2Flag | ( | DtLE_DetonField2Flag | flag, |
| bool & | value | ||
| ) | const [virtual] |
Get the value for a specific flag from the second flags field.
Returns false if the field is not present in the PDU.
| virtual bool DtLeDetonationPdu::getDeton2FlagsField | ( | DtU8 & | field | ) | const [virtual] |
Get flags field 2 (this field is automatically maintained by the PDU as other PDU fields are set).
Returns false if this field is not present.
| virtual bool DtLeDetonationPdu::getEventID_Application | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getEventID_Event | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getEventID_Site | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getLocationEntity | ( | DtLeEntityLocationEntityCoordinates & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getLocationWorld | ( | DtLeEntityLocationWorldCoordinates & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getMunitionID_Application | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getMunitionID_Entity | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getMunitionID_Site | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getOrientation | ( | DtLeEntityOrientation & | value | ) | const [virtual] |
| virtual bool DtLeDetonationPdu::getTargetEntityID | ( | DtLeEntityID & | id | ) | const [virtual] |
| virtual DtPduKind DtLeDetonationPdu::internalGetPduKind | ( | ) | const [protected, virtual] |
Returns the internal PDU kind.
Implements DtPdu.
| virtual int DtLeDetonationPdu::locationEntityOffset | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::locationWorldOffset | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::munitionID_Offset1 | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::munitionID_Offset2 | ( | ) | const [protected, virtual] |
| virtual int DtLeDetonationPdu::munitionOrientationOffset | ( | ) | const [protected, virtual] |
| virtual DtNetLeDetonationPdu* DtLeDetonationPdu::netPduStruct | ( | ) | const [protected, virtual] |
Casts the netPdu element to our network struct.
| DtLeDetonationPdu& DtLeDetonationPdu::operator= | ( | const DtLeDetonationPdu & | orig | ) |
Assignment operator.
| virtual void DtLeDetonationPdu::printData | ( | ) | const [virtual] |
Print the data contained by this PDU.
Reimplemented from DtPdu.
| virtual void DtLeDetonationPdu::printDataToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the data to a stream.
Reimplemented from DtPdu.
| virtual void DtLeDetonationPdu::printHeader | ( | ) | const [virtual] |
Print the header (override to include the new sub-protocol field).
Reimplemented from DtPdu.
| virtual void DtLeDetonationPdu::printHeaderToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the header to a stream.
Reimplemented from DtPdu.
| static void DtLeDetonationPdu::removeCallback | ( | DtExerciseConn * | conn, |
| DtLeDetonationPduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
| virtual int DtLeDetonationPdu::resultOffset | ( | ) | const [protected, virtual] |
| DtLeDetonationPdu* DtLeDetonationPdu::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 DtLeDetonationPdu::setBurstFuse | ( | DtU16 | value | ) | [virtual] |
Set/Get burst fuse (optional).
| virtual void DtLeDetonationPdu::setBurstMunitionType | ( | DtEntityType & | type | ) | [virtual] |
Set/Get burst munition type.
| virtual void DtLeDetonationPdu::setBurstQuantity | ( | DtU16 | value | ) | [virtual] |
Set/Get burst quantity (optional).
| virtual void DtLeDetonationPdu::setBurstRate | ( | DtU16 | value | ) | [virtual] |
Set/Get burst rate (optional).
| virtual void DtLeDetonationPdu::setBurstWarhead | ( | DtU16 | value | ) | [virtual] |
Set/Get burst warhead (optional).
| virtual void DtLeDetonationPdu::setDeton2Flag | ( | DtLE_DetonField2Flag | flag | ) | [protected, virtual] |
Set second detonation flag.
| virtual void DtLeDetonationPdu::setDeton2FlagsField | ( | DtU8 | value | ) | [protected, virtual] |
Set second detonation flags field.
| virtual void DtLeDetonationPdu::setDetonationResult | ( | DtU8 | value | ) | [virtual] |
Set/Get detonation result.
| virtual void DtLeDetonationPdu::setDetonFlag | ( | DtLE_DetonFieldFlag | flag | ) | [protected, virtual] |
Set first detonation flag.
| virtual void DtLeDetonationPdu::setDetonFlagsField | ( | DtU8 | value | ) | [protected, virtual] |
Set first detonation flags field.
| virtual void DtLeDetonationPdu::setEventID_Application | ( | DtU8 | value | ) | [virtual] |
Set/Get event ID application (optional).
| virtual void DtLeDetonationPdu::setEventID_Event | ( | DtU16 | value | ) | [virtual] |
Set/Get event ID event.
| virtual void DtLeDetonationPdu::setEventID_Site | ( | DtU8 | value | ) | [virtual] |
Set/Get event ID site (optional).
| virtual void DtLeDetonationPdu::setFiringEntityID | ( | const DtLeEntityID & | id | ) | [virtual] |
Set/Get firing entity ID.
| virtual void DtLeDetonationPdu::setLocationEntity | ( | const DtLeEntityLocationEntityCoordinates & | value | ) | [virtual] |
Set/Get entity location (entity coordinates).
In this PDU, entity location is stored in world coordinates or entity coordinates but not both. Get returns false if the coordinates are stored in world coordinates.
| virtual void DtLeDetonationPdu::setLocationWorld | ( | const DtLeEntityLocationWorldCoordinates & | value | ) | [virtual] |
Set/Get entity location (world coordinates).
In this PDU, entity location is stored in world coordinates or entity coordinates but not both. Get returns false if the coordinates are stored in entity coordinates.
| virtual void DtLeDetonationPdu::setMunitionID_Application | ( | DtU8 | value | ) | [virtual] |
Set/Get munition ID application (optional).
| virtual void DtLeDetonationPdu::setMunitionID_Entity | ( | DtU16 | value | ) | [virtual] |
Set/Get munition ID entity (optional)
| virtual void DtLeDetonationPdu::setMunitionID_Site | ( | DtU8 | value | ) | [virtual] |
Set/Get munition ID site (optional).
| virtual void DtLeDetonationPdu::setOrientation | ( | const DtLeEntityOrientation & | value | ) | [virtual] |
Set/Get entity orientation.
| virtual void DtLeDetonationPdu::setSubProtocol | ( | DtSubProtocol | value | ) | [virtual] |
Set/Get the sub-protocol number.
| virtual void DtLeDetonationPdu::setTargetEntityID | ( | const DtLeEntityID & | id | ) | [virtual] |
Some of 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 target entity ID (optional).
| virtual void DtLeDetonationPdu::setVelocity | ( | const DtLeEntityLinearVelocity & | value | ) | [virtual] |
Set/Get entity linear velocity.
| virtual DtSubProtocol DtLeDetonationPdu::subProtocol | ( | ) | const [virtual] |
| virtual int DtLeDetonationPdu::targetEntityID_Offset | ( | ) | const [protected, virtual] |
| virtual char* DtLeDetonationPdu::var | ( | ) | const [protected, virtual] |
Returns a pointer to the first byte of variable length data.
| virtual const DtLeEntityLinearVelocity& DtLeDetonationPdu::velocity | ( | ) | const [virtual] |
| virtual int DtLeDetonationPdu::velocityOffset | ( | ) | const [protected, virtual] |
DtLeEntityID DtLeDetonationPdu::myEntityID [protected] |
Temporary objects for reference returns.
DtEntityType DtLeDetonationPdu::myEntityType [protected] |
const int DtLeDetonationPdu::theStaticSize [static, protected] |
Size of PDU with zero parameter records.
