VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtLeDetonationPdu Class Reference

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. More...
 
 DtLeDetonationPdu (const DtNetLeDetonationPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 
 DtLeDetonationPdu (const DtLeDetonationPdu &orig)
 
virtual ~DtLeDetonationPdu ()
 destructor More...
 
DtLeDetonationPduoperator= (const DtLeDetonationPdu &orig)
 Assignment operator. More...
 
virtual void setSubProtocol (DtSubProtocol value)
 Set/Get the sub-protocol number. More...
 
virtual DtSubProtocol subProtocol () const
 
virtual void setFiringEntityID (const DtLeEntityID &id)
 Set/Get firing entity ID. More...
 
virtual const DtLeEntityIDfiringEntityID () const
 
virtual DtU8 detonFlagsField () const
 Get flags field 1 (this field is automatically maintained by the PDU as other PDU fields are set). More...
 
virtual bool getDeton2FlagsField (DtU8 &field) const
 Get flags field 2 (this field is automatically maintained by the PDU as other PDU fields are set). More...
 
virtual bool detonFlag (DtLE_DetonFieldFlag flag) const
 Get the value for a specific flag from the first flags field. More...
 
virtual bool getDeton2Flag (DtLE_DetonField2Flag flag, bool &value) const
 Get the value for a specific flag from the second flags field. More...
 
virtual void setTargetEntityID (const DtLeEntityID &id)
 Some of following accessor functions refer to records which are optional. More...
 
virtual bool getTargetEntityID (DtLeEntityID &id) const
 
virtual void setMunitionID_Site (DtU8 value)
 Set/Get munition ID site (optional). More...
 
virtual bool getMunitionID_Site (DtU8 &value) const
 
virtual void setMunitionID_Application (DtU8 value)
 Set/Get munition ID application (optional). More...
 
virtual bool getMunitionID_Application (DtU8 &value) const
 
virtual void setMunitionID_Entity (DtU16 value)
 Set/Get munition ID entity (optional) More...
 
virtual bool getMunitionID_Entity (DtU16 &value) const
 
virtual void setEventID_Site (DtU8 value)
 Set/Get event ID site (optional). More...
 
virtual bool getEventID_Site (DtU8 &value) const
 
virtual void setEventID_Application (DtU8 value)
 Set/Get event ID application (optional). More...
 
virtual bool getEventID_Application (DtU8 &value) const
 
virtual void setEventID_Event (DtU16 value)
 Set/Get event ID event. More...
 
virtual bool getEventID_Event (DtU16 &value) const
 
virtual void setLocationWorld (const DtLeEntityLocationWorldCoordinates &value)
 Set/Get entity location (world coordinates). More...
 
virtual bool getLocationWorld (DtLeEntityLocationWorldCoordinates &value) const
 
virtual void setLocationEntity (const DtLeEntityLocationEntityCoordinates &value)
 Set/Get entity location (entity coordinates). More...
 
virtual bool getLocationEntity (DtLeEntityLocationEntityCoordinates &value) const
 
virtual void setVelocity (const DtLeEntityLinearVelocity &value)
 Set/Get entity linear velocity. More...
 
virtual const
DtLeEntityLinearVelocity
velocity () const
 
virtual void setOrientation (const DtLeEntityOrientation &value)
 Set/Get entity orientation. More...
 
virtual bool getOrientation (DtLeEntityOrientation &value) const
 
virtual void setBurstMunitionType (DtEntityType &type)
 Set/Get burst munition type. More...
 
virtual const DtEntityTypeburstMunitionType () const
 
virtual void setBurstWarhead (DtU16 value)
 Set/Get burst warhead (optional). More...
 
virtual bool getBurstWarhead (DtU16 &value) const
 
virtual void setBurstFuse (DtU16 value)
 Set/Get burst fuse (optional). More...
 
virtual bool getBurstFuse (DtU16 &value) const
 
virtual void setBurstQuantity (DtU16 value)
 Set/Get burst quantity (optional). More...
 
virtual bool getBurstQuantity (DtU16 &value) const
 
virtual void setBurstRate (DtU16 value)
 Set/Get burst rate (optional). More...
 
virtual bool getBurstRate (DtU16 &value) const
 
virtual void setDetonationResult (DtU8 value)
 Set/Get detonation result. More...
 
virtual DtU8 detonationResult () const
 
virtual void printData () const
 Print the data contained by this PDU. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the data to a stream. More...
 
virtual void printHeader () const
 Print the header (override to include the new sub-protocol field). More...
 
virtual void printHeaderToStream (std::ostream &stream) const
 Print the header to a stream. More...
 
- Public Member Functions inherited from DtInteraction
 DtInteraction ()
 default constructor More...
 
virtual ~DtInteraction ()
 destructor More...
 
 DtInteraction (const DtInteraction &orig)
 copy constructor More...
 
DtInteractionoperator= (const DtInteraction &orig)
 assignment operator More...
 
- Public Member Functions inherited from DtPduWithAttributeRecordSets
 DtPduWithAttributeRecordSets ()
 Constructor. More...
 
 DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig)
 Constructor. More...
 
DtPduWithAttributeRecordSetsoperator= (const DtPduWithAttributeRecordSets &other)
 Assignment operator. More...
 
virtual ~DtPduWithAttributeRecordSets ()
 Destructor. More...
 
virtual void printToStream (std::ostream &stream) const
 Print the contents of the PDU. This will call DtPdu's printToStream and also call printRecordSets() More...
 
virtual void printRecordSets (bool printEntityObjectId=false) const
 Prints the Record Sets to DtInfo. More...
 
virtual void printRecordSetsToStream (std::ostream &stream, bool printEntityObjectId=false) const
 Prints the Record Sets to the specified stream. More...
 
virtual void addRecord (std::auto_ptr< DtStandardVariableRecord > record, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Adds a Record. More...
 
virtual void removeRecord (unsigned int index, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes a Record. More...
 
virtual void clearRecordSet (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes all Records and deletes the recordSet for the given Entity/Object Identifier. More...
 
virtual void clearAllRecordSets ()
 Removes all RecordSets. More...
 
virtual std::vector
< DtEntityIdentifier
recordSetIdentifiers () const
 Returns a vector of Entity/Object Identifiers. These are the Identifiers for the Record Sets. More...
 
virtual void getRecordSetIdentifiers (std::vector< DtEntityIdentifier > &entityIdVector) const
 Returns by reference the vector of Entity/Object Identifiers. More...
 
virtual const
DtStandardVariableRecordPtrVector
records (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
 This will return the Records for a given Entity/Object Identifier. More...
 
virtual const
DtAttributeRecordSet
recordSet (const DtEntityIdentifier &id) const
 This will return the Record Set for a given Entity/Object Identifier. More...
 
virtual const
DtStandardVariableRecordPtrVector 
allRecords () const
 This will return the Records of all Record Sets. More...
 
virtual unsigned int numberOfRecords () const
 Returns the number of records for all Record Sets. More...
 
virtual unsigned int numberOfRecords (const DtEntityIdentifier &id) const
 Returns the number of records in the Record Set for the given Entity/Object Identifier. More...
 
virtual bool containsStandardRecordSets () const
 Returns if this PDU contains Standard Record Sets. (This is only applicable to DIS 7 and higher). More...
 
virtual const DtSimulationAddressattributePduSimulationAddress () const
 Returns the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. More...
 
virtual void setAttributePduSimulationAddress (const DtSimulationAddress &addr)
 Sets the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. More...
 
virtual void encode ()
 Encode method. More...
 
virtual void decode (DtPduFactory *pduFactory=0)
 Decode method. More...
 
virtual unsigned int attributeRecordSetsNetSize () const
 Network Size of the all Attribute Record Sets. More...
 
virtual unsigned int recordSetsNetSize () const
 Network Size of the all Record Sets. More...
 
virtual void setStandardVariableRecordFactory (DtStandardVariableRecordFactory *factory)
 Sets/gets the Standard Variable Record Factory used for decoding. More...
 
virtual
DtStandardVariableRecordFactory
standardVariableRecordFactory () const
 
virtual unsigned int numberOfRecordSets () const
 Gets the number of Attribute Record Sets. More...
 
virtual const
DtAttributeRecordSetMap
attributeRecordSetMap () const
 Get the AttributeRecordSet Map. More...
 
virtual int computeMasterAttributeRecordType () const
 Get the Master Attribute Record Type (if applicable, this will return MULTIPLES_PRESENT if not) More...
 
virtual void setAttributeStrategy (DtAttributePduStrategy strat)
 
virtual DtAttributePduStrategy attributePduStrategy () const
 
virtual bool shouldAttributePduBeCoupled () const
 
- Public Member Functions inherited from DtPdu
virtual ~DtPdu ()
 Destructor. More...
 
 DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor. More...
 
DtPduoperator= (const DtPdu &pdu)
 Assignment operator. More...
 
virtual void * packet () const
 Older function that returns a pointer to the network representation. More...
 
virtual int status () const
 Get PDU status. More...
 
virtual void setVersion (int vers)
 Set/Get protocol version from PDU header. More...
 
virtual int protocolVersion () const
 
virtual void setExerciseId (int id)
 Set/Get exerciseID in PDU header. More...
 
virtual int exerciseId () const
 
virtual DtPduKind kind () const
 Returns PDU kind from PDU header. More...
 
virtual DtProtocolFamily protocolFamily () const
 Returns protocol family from PDU header. More...
 
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the PDU header's time stamp to reflect time and type. More...
 
virtual DtTime timeStamp () const
 Return the time (in seconds past an hour) encoded in the PDU header's time stamp. More...
 
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp, as indicated in PDU header. More...
 
virtual void setReceivedTime (DtTime t)
 absRealTime when PDU was received into buffer. More...
 
virtual DtTime receivedTime () const
 
virtual void setPduLength (unsigned int length)
 Set the PDU header's length. More...
 
virtual unsigned int pduLength () const
 Return the length of the PDU, as indicated in the PDU header. More...
 
virtual void setPduStatus (int)
 Set the PDU Status in the PDU header. More...
 
virtual int pduStatus () const
 Returns the PDU Status from the PDU header. More...
 
virtual void setTransferredEntityIndicator (bool difference)
 Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference. More...
 
virtual bool transferredEntityIndicator () const
 Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference. More...
 
virtual void setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator)
 Set the LVC Indicator in the PDU header. More...
 
virtual DtPduStatusLVCIndicator lvcIndicator () const
 Returns the LVC Indicator from the PDU header. More...
 
virtual void setCoupledExtensionIndicator (bool coupled)
 Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled. More...
 
virtual bool coupledExtensionIndicator () const
 Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled. More...
 
virtual void setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator)
 Set the Fire Type Indicator in the PDU header. More...
 
virtual
DtPduStatusFireTypeIndicator 
fireTypeIndicator () const
 Returns the Fire Type Indicator from the PDU header. More...
 
virtual void setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator)
 Set the Detonation Type Indicator in the PDU header. More...
 
virtual
DtPduStatusDetonationTypeIndicator 
detonationTypeIndicator () const
 Returns the Detonation Type Indicator from the PDU header. More...
 
virtual void setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator)
 Set the Radio Attached Indicator in the PDU header. More...
 
virtual
DtPduStatusRadioAttachedIndicator 
radioAttachedIndicator () const
 Returns the Radio Attached Indicator from the PDU header. More...
 
virtual void setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator)
 Set the Intercom Attached Indicator in the PDU header. More...
 
virtual
DtPduStatusIntercomAttachedIndicator 
intercomAttachedIndicator () const
 Returns the Intercom Attached Indicator from the PDU header. More...
 
virtual void setIffSimulationMode (bool interactive)
 Set the IFF Simulation Mode in the PDU header. More...
 
virtual bool iffSimulationMode () const
 Returns the IFF Simulation Mode from the PDU header. More...
 
virtual void setActiveInterrogationIndicator (bool active)
 Set the Active Interrogation Indicator in the PDU header. More...
 
virtual bool activeInterrogationIndicator () const
 Returns the Active Interrogation Indicator from the PDU header. More...
 
virtual DtTime guessTimeValid (DtTime referenceTime) const
 Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour. More...
 
virtual DtNetPduHeadernetHeader () const
 Returns a pointer to the PDU's header. More...
 
virtual void print () const
 Print the contents of the PDU by calling printToStream(DtInfo). More...
 
virtual void printDataToString (DtString &str) const
 
virtual void printPduInHexToStream (std::ostream &stream, unsigned int numberOfColumns) const
 Prints the entire PDU's internal buffer to the stream in Hex. More...
 
virtual bool isTransientPdu () const
 This method returns true if transient, false if state. More...
 
- Public Member Functions inherited from DtBaseMsg
virtual ~DtBaseMsg ()
 Destructor. More...
 
 DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor. More...
 
DtBaseMsgoperator= (const DtBaseMsg &msg)
 Assignment. More...
 
virtual const char * netRep () const
 Get network representation. More...
 
virtual int length () const
 Get size of message. More...
 
 DtBaseMsg ()
 Constructor Object is not fully constructed until initMsg is called. More...
 
void initMsg (int size, DtBufferPtr bufferPtr)
 
void initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
 
virtual void changeSize (int size)
 Changes the size of the message. More...
 
virtual void changeBufferSize (int size)
 Changes the size of the message buffer, but not the message itself. More...
 
virtual void insertBytes (int offset, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated offset into the net rep. More...
 
virtual void insertBytes (void *address, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated address. More...
 
virtual void deleteBytes (int offset, int numBytes)
 Deletes numBytes bytes at the indicated offset in the net rep. More...
 
virtual void deleteBytes (void *address, int numBytes)
 Deletes numBytes bytes starting at the indicated address. More...
 
virtual void clearAll ()
 Zeros out all bytes in the network representation. More...
 
virtual void * newInternalBuffer (int size)
 Sets myInternalBuff to point to a malloc'ed buffer of size bytes. More...
 

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Create a DtLeDetonationPdu. More...
 
static void addCallback (DtExerciseConn *conn, DtLeDetonationPduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received. More...
 
static void removeCallback (DtExerciseConn *conn, DtLeDetonationPduCb cb, void *usr)
 

Protected Member Functions

virtual DtPduKind internalGetPduKind () const
 Returns the internal PDU kind. More...
 
virtual DtNetLeDetonationPdunetPduStruct () const
 Casts the netPdu element to our network struct. More...
 
DtLeDetonationPduself () const
 Casts the 'this' pointer for changing elements in a const function. More...
 
virtual char * var () const
 Returns a pointer to the first byte of variable length data. More...
 
virtual void setDetonFlagsField (DtU8 value)
 Set first detonation flags field. More...
 
virtual void setDeton2FlagsField (DtU8 value)
 Set second detonation flags field. More...
 
virtual void setDetonFlag (DtLE_DetonFieldFlag flag)
 Set first detonation flag. More...
 
virtual void setDeton2Flag (DtLE_DetonField2Flag flag)
 Set second detonation flag. More...
 
virtual int detonFlagFieldOffset () const
 Returns the offset (in bytes) of a field within the variable data region. More...
 
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 Member Functions inherited from DtPduWithAttributeRecordSets
virtual void deepAttributeRecordSetMapCopy (const DtAttributeRecordSetMap &orig)
 Performs a deep copy. More...
 
virtual void printRecordSetToStream (const DtEntityIdentifier &id, std::ostream &stream) const
 
- Protected Member Functions inherited from DtPdu
 DtPdu ()
 Constructor. More...
 
virtual void setStatus (int okStatus)
 Sets the PDU's status to okStatus. More...
 
virtual void initPdu (int size, DtBufferPtr buffer)
 Must be called after default ctor before PDU is completely constructed. More...
 
virtual void initPdu (const void *initial, DtBufferPtr buffer, DtPduFactory *pduFactory)
 Called by from-net-rep ctor. Initializes DtBaseMsg. More...
 
virtual DtProtocolFamily kindToFamily (DtPduKind kind) const
 Maps PDU kind to ProtocolFamily. More...
 
virtual void sizeChanged (int size)
 Called by changeSize. Sets the size in the header to size. More...
 
virtual void clearData ()
 zeros out all bytes after the PDU header. More...
 
virtual void initHeader (DtPduKind kind, int size)
 Initializes PDU header. Called by initPdu. More...
 
virtual bool isTEIApplicable () const
 Returns whether a PDU Status is applicable to this PDU (based on PDU Type) These methods are only relevant in DIS 7 and greater. More...
 
virtual bool isLVCApplicable () const
 
virtual bool isCEIApplicable () const
 
virtual bool isFTIApplicable () const
 
virtual bool isDTIApplicable () const
 
virtual bool isRAIApplicable () const
 
virtual bool isIAIApplicable () const
 
virtual bool isISMApplicable () const
 
virtual bool isAIIApplicable () const
 

Protected Attributes

DtLeEntityID myEntityID
 Temporary objects for reference returns. More...
 
DtLeEntityLinearVelocity myVelocity
 
DtEntityType myEntityType
 
- Protected Attributes inherited from DtPduWithAttributeRecordSets
DtAttributeRecordSetMap myAttributeRecordSetMap
 The Map which holds the Record Sets (Set of Record Sets) where the Entity Identifier is the key. More...
 
bool isRecordSetOwned
 
bool isPduExtending
 
DtStandardVariableRecordFactorymySVRFactory
 
DtPduDecodermyAttributeDecoder
 
DtPduEncodermyAttributeEncoder
 
DtSimulationAddress myAttributePduOriginatingSimulationAddress
 
DtAttributePduStrategy myAttributePduStrategy
 
- Protected Attributes inherited from DtPdu
DtPduEncodermyEncoder
 
DtPduDecodermyDecoder
 
int myOKStatus
 
DtTime myReceivedTime
 
- Protected Attributes inherited from DtBaseMsg
void * myNetMsg
 
void * myInternalBuff
 
int myIntBuffSize
 
int myMsgSize
 
int myNetworkMsgSize
 

Static Protected Attributes

static const int theStaticSize
 Size of PDU with zero parameter records. More...
 
- Static Protected Attributes inherited from DtPduWithAttributeRecordSets
static const DtAttributeRecordSet theEmptyAttributeRecordSet
 

Detailed Description

Instances of DtLeDetonationPdu are used to send firing information for live entities.

Constructor & Destructor Documentation

DtLeDetonationPdu::DtLeDetonationPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtLeDetonationPdu::DtLeDetonationPdu ( const DtNetLeDetonationPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
DtLeDetonationPdu::DtLeDetonationPdu ( const DtLeDetonationPdu orig)
virtual DtLeDetonationPdu::~DtLeDetonationPdu ( )
virtual

destructor

Member Function Documentation

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
protectedvirtual
virtual int DtLeDetonationPdu::burstOffset2 ( ) const
protectedvirtual
virtual int DtLeDetonationPdu::burstOffset3 ( ) const
protectedvirtual
static DtPdu* DtLeDetonationPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
static

Create a DtLeDetonationPdu.

Caller is responsible for deletion.

virtual int DtLeDetonationPdu::deton2FlagFieldOffset ( ) const
protectedvirtual
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
protectedvirtual

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
protectedvirtual
virtual int DtLeDetonationPdu::eventID_Offset2 ( ) const
protectedvirtual
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
protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual int DtLeDetonationPdu::locationEntityOffset ( ) const
protectedvirtual
virtual int DtLeDetonationPdu::locationWorldOffset ( ) const
protectedvirtual
virtual int DtLeDetonationPdu::munitionID_Offset1 ( ) const
protectedvirtual
virtual int DtLeDetonationPdu::munitionID_Offset2 ( ) const
protectedvirtual
virtual int DtLeDetonationPdu::munitionOrientationOffset ( ) const
protectedvirtual
virtual DtNetLeDetonationPdu* DtLeDetonationPdu::netPduStruct ( ) const
protectedvirtual

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
protectedvirtual
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)
protectedvirtual

Set second detonation flag.

virtual void DtLeDetonationPdu::setDeton2FlagsField ( DtU8  value)
protectedvirtual

Set second detonation flags field.

virtual void DtLeDetonationPdu::setDetonationResult ( DtU8  value)
virtual

Set/Get detonation result.

virtual void DtLeDetonationPdu::setDetonFlag ( DtLE_DetonFieldFlag  flag)
protectedvirtual

Set first detonation flag.

virtual void DtLeDetonationPdu::setDetonFlagsField ( DtU8  value)
protectedvirtual

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
protectedvirtual
virtual char* DtLeDetonationPdu::var ( ) const
protectedvirtual

Returns a pointer to the first byte of variable length data.

virtual const DtLeEntityLinearVelocity& DtLeDetonationPdu::velocity ( ) const
virtual
virtual int DtLeDetonationPdu::velocityOffset ( ) const
protectedvirtual

Member Data Documentation

DtLeEntityID DtLeDetonationPdu::myEntityID
protected

Temporary objects for reference returns.

DtEntityType DtLeDetonationPdu::myEntityType
protected
DtLeEntityLinearVelocity DtLeDetonationPdu::myVelocity
protected
const int DtLeDetonationPdu::theStaticSize
staticprotected

Size of PDU with zero parameter records.


The documentation for this class was generated from the following file:

Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)