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

Instances of DtFireInteraction are used to represent the firing of a weapon. More...

+ Inheritance diagram for DtFirePdu:
+ Collaboration diagram for DtFirePdu:

Public Types

enum  { PduStaticSize =96 }
 

Public Member Functions

 DtFirePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
 DtFirePdu (const DtNetFirePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 
 DtFirePdu (const DtEntityIdentifier &attacker, const DtEntityIdentifier &target, const DtEntityIdentifier &munition, const DtEventID &eventId, const DtVector &location, const DtBurstDescriptor &burst, const DtVector32 &linVelocity, const double range, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
virtual const DtObjectIdattackerId () const
 
virtual void setAttackerId (const DtObjectId &id)
 
virtual const DtObjectIdtargetId () const
 
virtual void setTargetId (const DtObjectId &id)
 
virtual const DtObjectIdmunitionId () const
 
virtual void setMunitionId (const DtObjectId &id)
 
virtual const DtEventIDeventId () const
 
virtual void setEventId (const DtEventID &id)
 
virtual unsigned long fireMissionIndex () const
 
virtual void setFireMissionIndex (unsigned long i)
 
virtual const DtVectorlocation () const
 
virtual void setLocation (const DtVector &location)
 
virtual const DtVector32velocity () const
 
virtual void setVelocity (const DtVector32 &velocity)
 
virtual double range () const
 
virtual void setRange (double range)
 
virtual DtDetonatorFuze fuseType () const
 
virtual void setFuseType (DtDetonatorFuze f)
 
virtual const DtEntityTypemunitionType () const
 
virtual void setMunitionType (const DtEntityType &t)
 
virtual int quantity () const
 
virtual void setQuantity (int q)
 
virtual int rate () const
 
virtual void setRate (int r)
 
virtual DtWarheadType warheadType () const
 
virtual void setWarheadType (DtWarheadType t)
 
virtual const DtBurstDescriptorburst () const
 NOT USED IN HLA. More...
 
virtual void setBurst (const DtBurstDescriptor &burst)
 
virtual void printData () const
 Print the PDU's data (not including header). More...
 
virtual void printDataToStream (std::ostream &stream) const
 
virtual void printDataToString (DtString &str) const
 
- 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 printHeader () const
 Print the PDU's header. This calls printHeaderToStream(DtInfo). More...
 
virtual void printHeaderToStream (std::ostream &stream) const
 Print the PDU's header to a stream. More...
 
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)
 
static void addCallback (DtExerciseConn *conn, DtFireInteractionCb cb, void *usr)
 
static void removeCallback (DtExerciseConn *conn, DtFireInteractionCb cb, void *usr)
 

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class. More...
 
- 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

DtObjectId att
 
DtObjectId tar
 
DtObjectId mun
 
DtEventID event
 
DtVector loc
 
DtVector32 vel
 
DtBurstDescriptor theBurst
 
DtEntityType myMunType
 
- 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
 

Additional Inherited Members

- Static Protected Attributes inherited from DtPduWithAttributeRecordSets
static const DtAttributeRecordSet theEmptyAttributeRecordSet
 

Detailed Description

Instances of DtFireInteraction are used to represent the firing of a weapon.

Examples

Member Enumeration Documentation

anonymous enum
Enumerator
PduStaticSize 

Constructor & Destructor Documentation

DtFirePdu::DtFirePdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtFirePdu::DtFirePdu ( const DtNetFirePdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
DtFirePdu::DtFirePdu ( const DtEntityIdentifier attacker,
const DtEntityIdentifier target,
const DtEntityIdentifier munition,
const DtEventID eventId,
const DtVector location,
const DtBurstDescriptor burst,
const DtVector32 linVelocity,
const double  range,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Member Function Documentation

static void DtFirePdu::addCallback ( DtExerciseConn conn,
DtFireInteractionCb  cb,
void *  usr 
)
static
virtual const DtObjectId& DtFirePdu::attackerId ( ) const
virtual
virtual const DtBurstDescriptor& DtFirePdu::burst ( ) const
virtual

NOT USED IN HLA.

static DtPdu* DtFirePdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
static
virtual const DtEventID& DtFirePdu::eventId ( ) const
virtual
virtual unsigned long DtFirePdu::fireMissionIndex ( ) const
virtual
virtual DtDetonatorFuze DtFirePdu::fuseType ( ) const
virtual
DtPduKind DtFirePdu::internalGetPduKind ( ) const
inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtFirePduKind.

virtual const DtVector& DtFirePdu::location ( ) const
virtual
virtual const DtObjectId& DtFirePdu::munitionId ( ) const
virtual
virtual const DtEntityType& DtFirePdu::munitionType ( ) const
virtual
virtual void DtFirePdu::printData ( ) const
virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

virtual void DtFirePdu::printDataToStream ( std::ostream &  stream) const
virtual

Reimplemented from DtPdu.

virtual void DtFirePdu::printDataToString ( DtString str) const
virtual

Reimplemented from DtPdu.

virtual int DtFirePdu::quantity ( ) const
virtual
virtual double DtFirePdu::range ( ) const
virtual
virtual int DtFirePdu::rate ( ) const
virtual
static void DtFirePdu::removeCallback ( DtExerciseConn conn,
DtFireInteractionCb  cb,
void *  usr 
)
static
virtual void DtFirePdu::setAttackerId ( const DtObjectId id)
virtual
virtual void DtFirePdu::setBurst ( const DtBurstDescriptor burst)
virtual
virtual void DtFirePdu::setEventId ( const DtEventID id)
virtual
virtual void DtFirePdu::setFireMissionIndex ( unsigned long  i)
virtual
virtual void DtFirePdu::setFuseType ( DtDetonatorFuze  f)
virtual
virtual void DtFirePdu::setLocation ( const DtVector location)
virtual
virtual void DtFirePdu::setMunitionId ( const DtObjectId id)
virtual
virtual void DtFirePdu::setMunitionType ( const DtEntityType t)
virtual
virtual void DtFirePdu::setQuantity ( int  q)
virtual
virtual void DtFirePdu::setRange ( double  range)
virtual
virtual void DtFirePdu::setRate ( int  r)
virtual
virtual void DtFirePdu::setTargetId ( const DtObjectId id)
virtual
virtual void DtFirePdu::setVelocity ( const DtVector32 velocity)
virtual
virtual void DtFirePdu::setWarheadType ( DtWarheadType  t)
virtual
virtual const DtObjectId& DtFirePdu::targetId ( ) const
virtual
virtual const DtVector32& DtFirePdu::velocity ( ) const
virtual
virtual DtWarheadType DtFirePdu::warheadType ( ) const
virtual

Member Data Documentation

DtObjectId DtFirePdu::att
protected
DtEventID DtFirePdu::event
protected
DtVector DtFirePdu::loc
protected
DtObjectId DtFirePdu::mun
protected
DtEntityType DtFirePdu::myMunType
protected
DtObjectId DtFirePdu::tar
protected
DtBurstDescriptor DtFirePdu::theBurst
protected
DtVector32 DtFirePdu::vel
protected

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)