 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
Instances of DtDataQueryPdu are used to send/receive data query PDUs. More...
Inheritance diagram for DtDataQueryPdu: Collaboration diagram for DtDataQueryPdu:Public Types | |
| enum | { PduStaticSize = 40 } |
Public Member Functions | |
| DtDataQueryPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtDataQueryPdu (const DtNetDataQueryPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0) | |
| unsigned long | requestId () const |
| Set/Get the request id. | |
| void | setRequestId (unsigned long id) |
| DtTime | timeInterval () const |
| Set/Get the time interval. | |
| void | setTimeInterval (DtTime seconds) |
| unsigned long | numFixedFields () const |
| Get the number of fixed fields. | |
| unsigned long | numVarFields () const |
| Get the number of variable fields. | |
| DtDatumParam | fixedDatumId (int index) const |
| Set/Get the fixed datum id at the specified index. | |
| int | setFixedDatumId (int index, DtDatumParam id) |
| DtDatumParam | varDatumId (int index) const |
| Set/Get the variable datum id at the specified index. | |
| int | setVarDatumId (int index, DtDatumParam id) |
| void | initDatumIds (unsigned long numFixedFields, unsigned long numVarFields) |
| Initialize the fixed and variable fields. | |
| virtual void | printData () const |
| Print the data contained by this PDU. | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print the data to a stream. | |
| Public Member Functions inherited from DtSimanPdu | |
| DtSimanPdu & | operator= (const DtSimanPdu &orig) |
| Assignment operator. | |
| virtual const DtEntityIdentifier & | senderId () const |
| Get the sender ID. | |
| virtual const DtEntityIdentifier & | receiverId () const |
| Get the receiver ID. | |
| virtual void | setSenderId (const DtEntityIdentifier &id) |
| Set the sender ID. | |
| virtual void | setReceiverId (const DtEntityIdentifier &id) |
| Set the receiver ID. | |
| Public Member Functions inherited from DtInteraction | |
| DtInteraction () | |
| default constructor | |
| virtual | ~DtInteraction () |
| destructor | |
| DtInteraction (const DtInteraction &orig) | |
| copy constructor | |
| DtInteraction & | operator= (const DtInteraction &orig) |
| assignment operator | |
| Public Member Functions inherited from DtPduWithAttributeRecordSets | |
| DtPduWithAttributeRecordSets () | |
| Constructor. | |
| DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig) | |
| Constructor. | |
| DtPduWithAttributeRecordSets & | operator= (const DtPduWithAttributeRecordSets &other) |
| Assignment operator. | |
| virtual | ~DtPduWithAttributeRecordSets () |
| Destructor. | |
| virtual void | printToStream (std::ostream &stream) const |
| Print the contents of the PDU. This will call DtPdu's printToStream and also call printRecordSets() | |
| virtual void | printRecordSets (bool printEntityObjectId=false) const |
| Prints the Record Sets to DtInfo. | |
| virtual void | printRecordSetsToStream (std::ostream &stream, bool printEntityObjectId=false) const |
| Prints the Record Sets to the specified stream. | |
| virtual void | addRecord (std::auto_ptr< DtStandardVariableRecord > record, const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) |
| Adds a Record. | |
| virtual void | removeRecord (unsigned int index, const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) |
| Removes a Record. | |
| virtual void | clearRecordSet (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) |
| Removes all Records and deletes the recordSet for the given Entity/Object Identifier. | |
| virtual void | clearAllRecordSets () |
| Removes all RecordSets. | |
| virtual std::vector < DtEntityIdentifier > | recordSetIdentifiers () const |
| Returns a vector of Entity/Object Identifiers. These are the Identifiers for the Record Sets. | |
| virtual void | getRecordSetIdentifiers (std::vector< DtEntityIdentifier > &entityIdVector) const |
| Returns by reference the vector of Entity/Object Identifiers. | |
| virtual const std::vector < DtStandardVariableRecord * > & | records (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const |
| This will return the Records for a given Entity/Object Identifier. | |
| virtual const DtAttributeRecordSet & | recordSet (const DtEntityIdentifier &id) const |
| This will return the Record Set for a given Entity/Object Identifier. | |
| virtual const std::vector < DtStandardVariableRecord * > | allRecords () const |
| This will return the Records of all Record Sets. | |
| virtual unsigned int | numberOfRecords () const |
| Returns the number of records for all Record Sets. | |
| virtual unsigned int | numberOfRecords (const DtEntityIdentifier &id) const |
| Returns the number of records in the Record Set for the given Entity/Object Identifier. | |
| virtual bool | containsStandardRecordSets () const |
| Returns if this PDU contains Standard Record Sets. (This is only applicable to DIS 7 and higher). | |
| virtual const DtSimulationAddress & | attributePduSimulationAddress () const |
| Returns the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. | |
| virtual void | setAttributePduSimulationAddress (const DtSimulationAddress &addr) |
| Sets the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. | |
| virtual void | encode () |
| Encode method. | |
| virtual void | decode (DtPduFactory *pduFactory=0) |
| Decode method. | |
| virtual unsigned int | attributeRecordSetsNetSize () const |
| Network Size of the all Attribute Record Sets. | |
| virtual unsigned int | recordSetsNetSize () const |
| Network Size of the all Record Sets. | |
| virtual void | setStandardVariableRecordFactory (DtStandardVariableRecordFactory *factory) |
| Sets/gets the Standard Variable Record Factory used for decoding. | |
| virtual DtStandardVariableRecordFactory * | standardVariableRecordFactory () const |
| virtual unsigned int | numberOfRecordSets () const |
| Gets the number of Attribute Record Sets. | |
| virtual const DtAttributeRecordSetMap & | attributeRecordSetMap () const |
| Get the AttributeRecordSet Map. | |
| virtual int | computeMasterAttributeRecordType () const |
| Get the Master Attribute Record Type (if applicable, this will return MULTIPLES_PRESENT if not) | |
| Public Member Functions inherited from DtPdu | |
| virtual | ~DtPdu () |
| Destructor. | |
| DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Copy constructor. | |
| DtPdu & | operator= (const DtPdu &pdu) |
| Assignment operator. | |
| virtual void * | packet () const |
| Older function that returns a pointer to the network representation. | |
| virtual int | status () const |
| Get PDU status. | |
| virtual void | setVersion (int vers) |
| Set/Get protocol version from PDU header. | |
| virtual int | protocolVersion () const |
| virtual void | setExerciseId (int id) |
| Set/Get exerciseID in PDU header. | |
| virtual int | exerciseId () const |
| virtual DtPduKind | kind () const |
| Returns PDU kind from PDU header. | |
| virtual DtProtocolFamily | protocolFamily () const |
| Returns protocol family from PDU header. | |
| virtual void | setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative) |
| Set the PDU header's time stamp to reflect time and type. | |
| virtual DtTime | timeStamp () const |
| Return the time (in seconds past an hour) encoded in the PDU header's time stamp. | |
| virtual DtTimeStampType | timeStampType () const |
| Return the type of the time stamp, as indicated in PDU header. | |
| virtual void | setPduLength (unsigned int length) |
| Set the PDU header's length. | |
| virtual unsigned int | pduLength () const |
| Return the length of the PDU, as indicated in the PDU header. | |
| virtual void | setPduStatus (int) |
| Set the PDU Status in the PDU header. | |
| virtual int | pduStatus () const |
| Returns the PDU Status from the PDU header. | |
| virtual void | setTransferredEntityIndicator (bool difference) |
| Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference. | |
| virtual bool | transferredEntityIndicator () const |
| Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference. | |
| virtual void | setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator) |
| Set the LVC Indicator in the PDU header. | |
| virtual DtPduStatusLVCIndicator | lvcIndicator () const |
| Returns the LVC Indicator from the PDU header. | |
| virtual void | setCoupledExtensionIndicator (bool coupled) |
| Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled. | |
| virtual bool | coupledExtensionIndicator () const |
| Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled. | |
| virtual void | setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator) |
| Set the Fire Type Indicator in the PDU header. | |
| virtual DtPduStatusFireTypeIndicator | fireTypeIndicator () const |
| Returns the Fire Type Indicator from the PDU header. | |
| virtual void | setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator) |
| Set the Detonation Type Indicator in the PDU header. | |
| virtual DtPduStatusDetonationTypeIndicator | detonationTypeIndicator () const |
| Returns the Detonation Type Indicator from the PDU header. | |
| virtual void | setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator) |
| Set the Radio Attached Indicator in the PDU header. | |
| virtual DtPduStatusRadioAttachedIndicator | radioAttachedIndicator () const |
| Returns the Radio Attached Indicator from the PDU header. | |
| virtual void | setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator) |
| Set the Intercom Attached Indicator in the PDU header. | |
| virtual DtPduStatusIntercomAttachedIndicator | intercomAttachedIndicator () const |
| Returns the Intercom Attached Indicator from the PDU header. | |
| virtual void | setIffSimulationMode (bool interactive) |
| Set the IFF Simulation Mode in the PDU header. | |
| virtual bool | iffSimulationMode () const |
| Returns the IFF Simulation Mode from the PDU header. | |
| virtual void | setActiveInterrogationIndicator (bool active) |
| Set the Active Interrogation Indicator in the PDU header. | |
| virtual bool | activeInterrogationIndicator () const |
| Returns the Active Interrogation Indicator from the PDU header. | |
| 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. | |
| virtual DtNetPduHeader * | netHeader () const |
| Returns a pointer to the PDU's header. | |
| virtual void | print () const |
| Print the contents of the PDU by calling printToStream(DtInfo). | |
| virtual void | printHeader () const |
| Print the PDU's header. This calls printHeaderToStream(DtInfo). | |
| virtual void | printHeaderToStream (std::ostream &stream) const |
| Print the PDU's header to a stream. | |
| 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. | |
| virtual bool | isTransientPdu () const |
| This method returns true if transient, false if state. | |
| Public Member Functions inherited from DtBaseMsg | |
| virtual | ~DtBaseMsg () |
| Destructor. | |
| DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Copy constructor. | |
| DtBaseMsg & | operator= (const DtBaseMsg &msg) |
| Assignment. | |
| virtual const char * | netRep () const |
| Get network representation. | |
| virtual int | length () const |
| Get size of message. | |
| DtBaseMsg () | |
| Constructor Object is not fully constructed until initMsg is called. | |
| void | initMsg (int size, DtBufferPtr bufferPtr) |
| void | initMsg (const void *initial, int size, DtBufferPtr bufferPtr) |
| virtual void | changeSize (int size, bool skipSizeChanged=false) |
| Changes the size of the message. | |
| virtual void | insertBytes (int offset, int numBytes, bool skipSizeChanged=false) |
| Inserts numBytes zeroed-out bytes at the indicated offset into the net rep. | |
| virtual void | insertBytes (void *address, int numBytes, bool skipSizeChanged=false) |
| Inserts numBytes zeroed-out bytes at the indicated address. | |
| virtual void | deleteBytes (int offset, int numBytes, bool skipSizeChanged=false) |
| Deletes numBytes bytes at the indicated offset in the net rep. | |
| virtual void | deleteBytes (void *address, int numBytes, bool skipSizeChanged=false) |
| Deletes numBytes bytes starting at the indicated address. | |
| virtual void | clearAll () |
| Zeros out all bytes in the network representation. | |
| virtual void * | newInternalBuffer (int size) |
| Sets myInternalBuff to point to a malloc'ed buffer of size bytes. | |
Static Public Member Functions | |
| static DtPdu * | create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0) |
| Create a DtDataQueryPdu. | |
| static void | addCallback (DtExerciseConn *conn, DtDataQueryPduCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. | |
| static void | removeCallback (DtExerciseConn *conn, DtDataQueryPduCb cb, void *usr) |
Protected Member Functions | |
| DtPduKind | internalGetPduKind () const |
| Returns the PDU kind associated with the derived PDU class. | |
Additional Inherited Members | |
| Protected Attributes inherited from DtSimanPdu | |
| DtEntityIdentifier | mySenderId |
| DtEntityIdentifier | myReceiverId |
Instances of DtDataQueryPdu are used to send/receive data query PDUs.
| DtDataQueryPdu::DtDataQueryPdu | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
| DtDataQueryPdu::DtDataQueryPdu | ( | const DtNetDataQueryPdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER, |
||
| DtPduFactory * | pduFactory = 0 |
||
| ) |
|
static |
Add (register)/Remove (deregister) function to be called when pdu is received.
|
static |
Create a DtDataQueryPdu.
Caller is responsible for deletion.
| DtDatumParam DtDataQueryPdu::fixedDatumId | ( | int | index | ) | const |
Set/Get the fixed datum id at the specified index.
| void DtDataQueryPdu::initDatumIds | ( | unsigned long | numFixedFields, |
| unsigned long | numVarFields | ||
| ) |
Initialize the fixed and variable fields.
|
inlineprotectedvirtual |
Returns the PDU kind associated with the derived PDU class.
Implements DtPdu.
References DtDataQueryPduKind.
| unsigned long DtDataQueryPdu::numFixedFields | ( | ) | const |
Get the number of fixed fields.
| unsigned long DtDataQueryPdu::numVarFields | ( | ) | const |
Get the number of variable fields.
|
virtual |
Print the data contained by this PDU.
Reimplemented from DtSimanPdu.
|
virtual |
Print the data to a stream.
Reimplemented from DtSimanPdu.
|
static |
| unsigned long DtDataQueryPdu::requestId | ( | ) | const |
Set/Get the request id.
| int DtDataQueryPdu::setFixedDatumId | ( | int | index, |
| DtDatumParam | id | ||
| ) |
| void DtDataQueryPdu::setRequestId | ( | unsigned long | id | ) |
| void DtDataQueryPdu::setTimeInterval | ( | DtTime | seconds | ) |
| int DtDataQueryPdu::setVarDatumId | ( | int | index, |
| DtDatumParam | id | ||
| ) |
| DtTime DtDataQueryPdu::timeInterval | ( | ) | const |
Set/Get the time interval.
| DtDatumParam DtDataQueryPdu::varDatumId | ( | int | index | ) | const |
Set/Get the variable datum id at the specified index.
