 |
VR-Link API Documentation for DIS
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Link API Documentation for DIS
|
Instances of DtDesignatorPduare used to communicate information about designator objects in DIS. More...
Inheritance diagram for DtDesignatorPdu: Collaboration diagram for DtDesignatorPdu:Public Types | |
| enum | { DtDesignatorStaticSizeVERS5 = 88, DtDesignatorStaticSizeVERS4 = 72 } |
| Enumerator to describe the size of PDU's across DIS versions. More... | |
| enum | { PduStaticSize = DtDesignatorStaticSizeVERS5 } |
| Static size is defaulted to DIS version 5. More... | |
Public Member Functions | |
| DtDesignatorPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Default constructor. More... | |
| DtDesignatorPdu (const DtNetDesignatorPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0) | |
| Constructor that takes a net packet. More... | |
| virtual void | printData () const |
| Prints the PDU's data to DtInfo. More... | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Prints the PDU's data to the specified stream. More... | |
| const DtEntityIdentifier & | designatingEntityId () const |
| Get/Set the entity ID of the entity that the designator is attached to. More... | |
| void | setDesignatingEntityId (const DtEntityIdentifier &id) |
| Get/Set the entity ID of the entity that the designator is attached to. More... | |
| DtDesignatorCodeName | codeName () const |
| Get/Set the designator code name. More... | |
| void | setCodeName (DtDesignatorCodeName name) |
| Get/Set the designator code name. More... | |
| const DtEntityIdentifier & | designatedEntityId () const |
| Get/Set the designated entity ID. More... | |
| void | setDesignatedEntityId (const DtEntityIdentifier &id) |
| Get/Set the designated entity ID. More... | |
| DtDesignatorCode | designatorCode () const |
| Get/Set the designator code. More... | |
| void | setDesignatorCode (DtDesignatorCode code) |
| Get/Set the designator code. More... | |
| float | power () const |
| Get/Set the designator power. More... | |
| void | setPower (float power) |
| Get/Set the designator power. More... | |
| float | wavelength () const |
| Get/Set the designator wavelength. More... | |
| void | setWavelength (float wavelength) |
| Get/Set the designator wavelength. More... | |
| const DtVector & | designatorSpotRelative () const |
| Get/Set the designator spot with respect to the designated entity. More... | |
| void | setDesignatorSpotRelative (const DtVector &loc) |
| Get/Set the designator spot with respect to the designated entity. More... | |
| const DtVector & | designatorSpotWorld () const |
| Get/Set the designator spot location. More... | |
| void | setDesignatorSpotWorld (const DtVector &loc) |
| Get/Set the designator spot location. More... | |
| DtDeadReckonTypes | deadReckoningAlgorithm () const |
| Get/Set the dead reckoning algorithm. More... | |
| void | setDeadReckoningAlgorithm (DtDeadReckonTypes alg) |
| Get/Set the dead reckoning algorithm. More... | |
| const DtVector & | linearAcceleration () const |
| Get/Set the designator spot's linear acceleration. More... | |
| void | setLinearAcceleration (const DtVector &acc) |
| Get/Set the designator spot's linear acceleration. More... | |
| Public Member Functions inherited from DtStateMsg | |
| DtStateMsg () | |
| default constructor More... | |
| virtual | ~DtStateMsg () |
| destructor More... | |
| DtStateMsg (const DtStateMsg &orig) | |
| copy constructor More... | |
| DtStateMsg & | operator= (const DtStateMsg &orig) |
| assignment operator More... | |
| Public Member Functions inherited from DtPduWithAttributeRecordSets | |
| DtPduWithAttributeRecordSets () | |
| Constructor. More... | |
| DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig) | |
| Constructor. More... | |
| DtPduWithAttributeRecordSets & | operator= (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 DtSimulationAddress & | attributePduSimulationAddress () 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... | |
| DtPdu & | operator= (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 DtNetPduHeader * | netHeader () 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 | 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... | |
| DtBaseMsg & | operator= (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 DtPdu * | create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0) |
| Creator method that takes a net packet and creates a DtDesignatorPdu. More... | |
| static void | addCallback (DtExerciseConn *conn, DtDesignatorPduCb cb, void *usr) |
| Register a callback on the receipt of a Designator PDU. More... | |
| static void | removeCallback (DtExerciseConn *conn, DtDesignatorPduCb cb, void *usr) |
| Remove a callback registered using addCallback(). More... | |
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 | |
| DtEntityIdentifier | theId |
| DtVector | loc |
| 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 |
| DtStandardVariableRecordFactory * | mySVRFactory |
| DtPduDecoder * | myAttributeDecoder |
| DtPduEncoder * | myAttributeEncoder |
| DtSimulationAddress | myAttributePduOriginatingSimulationAddress |
| DtAttributePduStrategy | myAttributePduStrategy |
| Protected Attributes inherited from DtPdu | |
| DtPduEncoder * | myEncoder |
| DtPduDecoder * | myDecoder |
| 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 |
Instances of DtDesignatorPduare used to communicate information about designator objects in DIS.
| anonymous enum |
| DtDesignatorPdu::DtDesignatorPdu | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Default constructor.
| DtDesignatorPdu::DtDesignatorPdu | ( | const DtNetDesignatorPdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER, |
||
| DtPduFactory * | pduFactory = 0 |
||
| ) |
Constructor that takes a net packet.
|
static |
Register a callback on the receipt of a Designator PDU.
| DtDesignatorCodeName DtDesignatorPdu::codeName | ( | ) | const |
Get/Set the designator code name.
|
static |
Creator method that takes a net packet and creates a DtDesignatorPdu.
| DtDeadReckonTypes DtDesignatorPdu::deadReckoningAlgorithm | ( | ) | const |
Get/Set the dead reckoning algorithm.
| const DtEntityIdentifier& DtDesignatorPdu::designatedEntityId | ( | ) | const |
Get/Set the designated entity ID.
| const DtEntityIdentifier& DtDesignatorPdu::designatingEntityId | ( | ) | const |
Get/Set the entity ID of the entity that the designator is attached to.
| DtDesignatorCode DtDesignatorPdu::designatorCode | ( | ) | const |
Get/Set the designator code.
| const DtVector& DtDesignatorPdu::designatorSpotRelative | ( | ) | const |
Get/Set the designator spot with respect to the designated entity.
| const DtVector& DtDesignatorPdu::designatorSpotWorld | ( | ) | const |
Get/Set the designator spot location.
This takes a world coordinate location.
|
inlineprotectedvirtual |
Returns the PDU kind associated with the derived PDU class.
Implements DtPdu.
References DtDesignatorPduKind.
| const DtVector& DtDesignatorPdu::linearAcceleration | ( | ) | const |
Get/Set the designator spot's linear acceleration.
| float DtDesignatorPdu::power | ( | ) | const |
Get/Set the designator power.
|
virtual |
Prints the PDU's data to DtInfo.
Reimplemented from DtPdu.
|
virtual |
Prints the PDU's data to the specified stream.
Reimplemented from DtPdu.
|
static |
Remove a callback registered using addCallback().
| void DtDesignatorPdu::setCodeName | ( | DtDesignatorCodeName | name | ) |
Get/Set the designator code name.
| void DtDesignatorPdu::setDeadReckoningAlgorithm | ( | DtDeadReckonTypes | alg | ) |
Get/Set the dead reckoning algorithm.
| void DtDesignatorPdu::setDesignatedEntityId | ( | const DtEntityIdentifier & | id | ) |
Get/Set the designated entity ID.
| void DtDesignatorPdu::setDesignatingEntityId | ( | const DtEntityIdentifier & | id | ) |
Get/Set the entity ID of the entity that the designator is attached to.
| void DtDesignatorPdu::setDesignatorCode | ( | DtDesignatorCode | code | ) |
Get/Set the designator code.
| void DtDesignatorPdu::setDesignatorSpotRelative | ( | const DtVector & | loc | ) |
Get/Set the designator spot with respect to the designated entity.
| void DtDesignatorPdu::setDesignatorSpotWorld | ( | const DtVector & | loc | ) |
Get/Set the designator spot location.
This takes a world coordinate location.
| void DtDesignatorPdu::setLinearAcceleration | ( | const DtVector & | acc | ) |
Get/Set the designator spot's linear acceleration.
| void DtDesignatorPdu::setPower | ( | float | power | ) |
Get/Set the designator power.
| void DtDesignatorPdu::setWavelength | ( | float | wavelength | ) |
Get/Set the designator wavelength.
| float DtDesignatorPdu::wavelength | ( | ) | const |
Get/Set the designator wavelength.
|
protected |
|
protected |
