 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
Instances of DtLeFirePdu are used to send firing information for live entities. More...
Inheritance diagram for DtLeFirePdu: Collaboration diagram for DtLeFirePdu:Public Member Functions | |
| DtLeFirePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtLeFirePdu (const DtNetLeFirePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| DtLeFirePdu (const DtLeFirePdu &orig) | |
| virtual | ~DtLeFirePdu () |
| destructor | |
| DtLeFirePdu & | operator= (const DtLeFirePdu &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 | fireFlagsField () const |
| Get flags field (this field is automatically maintained by the PDU as other PDU fields are set). | |
| virtual bool | fireFlag (DtLE_FireFieldFlag flag) const |
| Get the value for a specific flag from the flags field. | |
| virtual void | setTargetEntityID (const DtLeEntityID &id) |
| Some of the 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 DtU16 | eventID_Event () const |
| virtual void | setLocation (const DtLeEntityLocationWorldCoordinates &value) |
| Set/Get entity location (optional). | |
| virtual bool | getLocation (DtLeEntityLocationWorldCoordinates &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 | setVelocity (const DtLeEntityLinearVelocity &value) |
| Set/Get entity linear velocity. | |
| virtual const DtLeEntityLinearVelocity & | velocity () const |
| virtual void | setRange (DtU16 value) |
| Set/Get range. | |
| virtual DtU16 | range () 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 DtLeFirePdu. | |
| static void | addCallback (DtExerciseConn *conn, DtLeFirePduCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. | |
| static void | removeCallback (DtExerciseConn *conn, DtLeFirePduCb cb, void *usr) |
Protected Member Functions | |
| virtual DtPduKind | internalGetPduKind () const |
| Returns the internal PDU kind. | |
| virtual DtNetLeFirePdu * | netPduStruct () const |
| Casts the netPdu element to our network struct. | |
| DtLeFirePdu * | 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 | setFireFlagsField (DtU8 value) |
| Set Fire Flags. | |
| virtual void | setFireFlag (DtLE_FireFieldFlag flag) |
| Set a flag of the flag field. | |
| virtual void | clearFireFlags (DtLE_FireFieldFlag flag) |
| Clear the flag and all following flags in the fire flags field. | |
| virtual int | fireFlagFieldOffset () const |
| Returns the offset (in bytes) of a field within the variable data region. | |
| 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 | locationOffset () const |
| virtual int | burstOffset1 () const |
| virtual int | burstOffset2 () const |
| virtual int | burstOffset3 () const |
| virtual int | velocityOffset () const |
| virtual int | rangeOffset () 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 DtLeFirePdu are used to send firing information for live entities.
| DtLeFirePdu::DtLeFirePdu | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
| DtLeFirePdu::DtLeFirePdu | ( | const DtNetLeFirePdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
| DtLeFirePdu::DtLeFirePdu | ( | const DtLeFirePdu & | orig | ) |
| virtual DtLeFirePdu::~DtLeFirePdu | ( | ) | [virtual] |
destructor
| static void DtLeFirePdu::addCallback | ( | DtExerciseConn * | conn, |
| DtLeFirePduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Add (register)/Remove (deregister) function to be called when pdu is received.
| virtual const DtEntityType& DtLeFirePdu::burstMunitionType | ( | ) | const [virtual] |
| virtual int DtLeFirePdu::burstOffset1 | ( | ) | const [protected, virtual] |
| virtual int DtLeFirePdu::burstOffset2 | ( | ) | const [protected, virtual] |
| virtual int DtLeFirePdu::burstOffset3 | ( | ) | const [protected, virtual] |
| virtual void DtLeFirePdu::clearFireFlags | ( | DtLE_FireFieldFlag | flag | ) | [protected, virtual] |
Clear the flag and all following flags in the fire flags field.
| static DtPdu* DtLeFirePdu::create | ( | const DtNetPacket * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Create a DtLeFirePdu.
Caller is responsible for deletion.
| virtual DtU16 DtLeFirePdu::eventID_Event | ( | ) | const [virtual] |
| virtual int DtLeFirePdu::eventID_Offset1 | ( | ) | const [protected, virtual] |
| virtual int DtLeFirePdu::eventID_Offset2 | ( | ) | const [protected, virtual] |
| virtual bool DtLeFirePdu::fireFlag | ( | DtLE_FireFieldFlag | flag | ) | const [virtual] |
Get the value for a specific flag from the flags field.
| virtual int DtLeFirePdu::fireFlagFieldOffset | ( | ) | 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 DtLeFirePdu::fireFlagsField | ( | ) | const [virtual] |
Get flags field (this field is automatically maintained by the PDU as other PDU fields are set).
| virtual const DtLeEntityID& DtLeFirePdu::firingEntityID | ( | ) | const [virtual] |
| virtual bool DtLeFirePdu::getBurstFuse | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getBurstQuantity | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getBurstRate | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getBurstWarhead | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getEventID_Application | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getEventID_Site | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getLocation | ( | DtLeEntityLocationWorldCoordinates & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getMunitionID_Application | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getMunitionID_Entity | ( | DtU16 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getMunitionID_Site | ( | DtU8 & | value | ) | const [virtual] |
| virtual bool DtLeFirePdu::getTargetEntityID | ( | DtLeEntityID & | id | ) | const [virtual] |
| virtual DtPduKind DtLeFirePdu::internalGetPduKind | ( | ) | const [protected, virtual] |
Returns the internal PDU kind.
Implements DtPdu.
| virtual int DtLeFirePdu::locationOffset | ( | ) | const [protected, virtual] |
| virtual int DtLeFirePdu::munitionID_Offset1 | ( | ) | const [protected, virtual] |
| virtual int DtLeFirePdu::munitionID_Offset2 | ( | ) | const [protected, virtual] |
| virtual DtNetLeFirePdu* DtLeFirePdu::netPduStruct | ( | ) | const [protected, virtual] |
Casts the netPdu element to our network struct.
| DtLeFirePdu& DtLeFirePdu::operator= | ( | const DtLeFirePdu & | orig | ) |
Assignment operator.
| virtual void DtLeFirePdu::printData | ( | ) | const [virtual] |
Print the data contained by this PDU.
Reimplemented from DtPdu.
| virtual void DtLeFirePdu::printDataToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the data to a stream.
Reimplemented from DtPdu.
| virtual void DtLeFirePdu::printHeader | ( | ) | const [virtual] |
Print the header (override to include the new sub-protocol field).
Reimplemented from DtPdu.
| virtual void DtLeFirePdu::printHeaderToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the header to a stream.
Reimplemented from DtPdu.
| virtual DtU16 DtLeFirePdu::range | ( | ) | const [virtual] |
| virtual int DtLeFirePdu::rangeOffset | ( | ) | const [protected, virtual] |
| static void DtLeFirePdu::removeCallback | ( | DtExerciseConn * | conn, |
| DtLeFirePduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
| DtLeFirePdu* DtLeFirePdu::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 DtLeFirePdu::setBurstFuse | ( | DtU16 | value | ) | [virtual] |
Set/Get burst fuse (optional).
| virtual void DtLeFirePdu::setBurstMunitionType | ( | DtEntityType & | type | ) | [virtual] |
Set/Get burst munition type.
| virtual void DtLeFirePdu::setBurstQuantity | ( | DtU16 | value | ) | [virtual] |
Set/Get burst quantity (optional).
| virtual void DtLeFirePdu::setBurstRate | ( | DtU16 | value | ) | [virtual] |
Set/Get burst rate (optional).
| virtual void DtLeFirePdu::setBurstWarhead | ( | DtU16 | value | ) | [virtual] |
Set/Get burst warhead (optional).
| virtual void DtLeFirePdu::setEventID_Application | ( | DtU8 | value | ) | [virtual] |
Set/Get event ID application (optional).
| virtual void DtLeFirePdu::setEventID_Event | ( | DtU16 | value | ) | [virtual] |
Set/Get event ID event.
| virtual void DtLeFirePdu::setEventID_Site | ( | DtU8 | value | ) | [virtual] |
Set/Get event ID site (optional).
| virtual void DtLeFirePdu::setFireFlag | ( | DtLE_FireFieldFlag | flag | ) | [protected, virtual] |
Set a flag of the flag field.
| virtual void DtLeFirePdu::setFireFlagsField | ( | DtU8 | value | ) | [protected, virtual] |
Set Fire Flags.
| virtual void DtLeFirePdu::setFiringEntityID | ( | const DtLeEntityID & | id | ) | [virtual] |
Set/Get firing entity ID.
| virtual void DtLeFirePdu::setLocation | ( | const DtLeEntityLocationWorldCoordinates & | value | ) | [virtual] |
Set/Get entity location (optional).
| virtual void DtLeFirePdu::setMunitionID_Application | ( | DtU8 | value | ) | [virtual] |
Set/Get munition ID application (optional).
| virtual void DtLeFirePdu::setMunitionID_Entity | ( | DtU16 | value | ) | [virtual] |
Set/Get munition ID entity (optional).
| virtual void DtLeFirePdu::setMunitionID_Site | ( | DtU8 | value | ) | [virtual] |
Set/Get munition ID site (optional).
| virtual void DtLeFirePdu::setRange | ( | DtU16 | value | ) | [virtual] |
Set/Get range.
| virtual void DtLeFirePdu::setSubProtocol | ( | DtSubProtocol | value | ) | [virtual] |
Set/Get the sub-protocol number.
| virtual void DtLeFirePdu::setTargetEntityID | ( | const DtLeEntityID & | id | ) | [virtual] |
Some of 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 target entity ID (optional).
| virtual void DtLeFirePdu::setVelocity | ( | const DtLeEntityLinearVelocity & | value | ) | [virtual] |
Set/Get entity linear velocity.
| virtual DtSubProtocol DtLeFirePdu::subProtocol | ( | ) | const [virtual] |
| virtual int DtLeFirePdu::targetEntityID_Offset | ( | ) | const [protected, virtual] |
| virtual char* DtLeFirePdu::var | ( | ) | const [protected, virtual] |
Returns a pointer to the first byte of variable length data.
| virtual const DtLeEntityLinearVelocity& DtLeFirePdu::velocity | ( | ) | const [virtual] |
| virtual int DtLeFirePdu::velocityOffset | ( | ) | const [protected, virtual] |
DtLeEntityID DtLeFirePdu::myEntityID [protected] |
Temporary objects for reference returns.
DtEntityType DtLeFirePdu::myEntityType [protected] |
DtLeEntityLinearVelocity DtLeFirePdu::myVelocity [protected] |
const int DtLeFirePdu::theStaticSize [static, protected] |
Size of PDU with zero parameter records.
