 |
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 DtActionRequestPdu are used to send/receive action request PDUs. More...
Inheritance diagram for DtActionRequestPdu: Collaboration diagram for DtActionRequestPdu:Public Types | |
| enum | { PduStaticSize =40 } |
| Public Types inherited from DtPduWithData | |
| enum | { PduStaticSize =40 } |
Public Member Functions | |
| DtActionRequestPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. More... | |
| DtActionRequestPdu (const DtNetActionRequestPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0) | |
| unsigned long | requestId () const |
| Set/Get the request id. More... | |
| void | setRequestId (unsigned long id) |
| unsigned long | actionId () const |
| Set/Get the action id. More... | |
| void | setActionId (unsigned long id) |
| 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... | |
| Public Member Functions inherited from DtPduWithData | |
| DtPduWithData () | |
| Constructor. More... | |
| virtual | ~DtPduWithData () |
| Destructor. More... | |
| DtPduWithData (const DtPduWithData &orig) | |
| DtPduWithData & | operator= (const DtPduWithData &orig) |
| Assignment operator. More... | |
| virtual int | numFixedFields () const |
| Returns number of fixed fields. More... | |
| virtual int | numVarFields () const |
| Returns number of variable length fields. More... | |
| virtual DtDatumParam | varDatumId (int index) const |
| Returns the datum param found in the index'th variable datum record. More... | |
| virtual DtDatumParam | fixedDatumId (int index) const |
| Returns the datum param found in the index'th fixed datum record. More... | |
| virtual DtDatumParam | datumId (DtDatumRecordType fixedOrVar, int index) const |
| Returns the datum param found in the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFIXED or DtVAR. More... | |
| virtual int | datumSizeBits (DtDatumRecordType fixedOrVar, int index) const |
| Returns the number of bits of data contained in the value fields of the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFIXED or DtVAR. More... | |
| virtual int | datumSizeBytes (DtDatumRecordType fixedOrVar, int index) const |
| Returns the number of bytes of data contained in the value fields of the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFIXED or DtVAR. More... | |
| virtual void | getIndex (DtDatumParam param, DtDatumRecordType *fixedOrVar, int *index, DtDatumRetCode *retcode=NULL) const |
| Looks through all fixed and variable records for one containing param as the parameter ID. More... | |
| virtual DtFloat32 | datumValFloat32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const |
| ******* INSPECTING DATUM VALUES BY INDEX ********* If you know the data type of the value contained in a particular record, use one of the following to return it. More... | |
| virtual DtFloat64 | datumValFloat64 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const |
| virtual unsigned long | datumValUnsigned32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const |
| virtual long | datumValInt32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const |
| virtual const char * | datumValByteArray (DtDatumRecordType fixedOrVar, int index) const |
| virtual DtFloat32 | datumValFloat32 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const |
| ******* INSPECTING DATUM VALUES BY PARAM ID ********* If you know the data type of the value contained in a particular record, use one of the following to return it. More... | |
| virtual DtFloat64 | datumValFloat64 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const |
| virtual unsigned long | datumValUnsigned32 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const |
| virtual long | datumValInt32 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const |
| virtual const char * | datumValByteArray (DtDatumParam param, DtDatumRetCode *retcode=NULL) const |
| virtual void | initDataSection (const DtDatumParam *fixedParams, const DtVarDatumSpec *specList) |
| ****************** MUTATOR FUNCTIONS ****************** More... | |
| virtual void | setNumFixedFields (int newNum) |
| Sets the number of fixed or variable fields to newNum. More... | |
| virtual void | setNumVarFields (int newNum) |
| virtual void | setDatumParam (DtDatumRecordType fixedOrVar, int index, DtDatumParam param, DtDatumRetCode *retcode=NULL) |
| Set the datum ID in the index'th fixed or variable datum record to param, depending on whether fixedOrVar is DtFIXED or DtVAR. More... | |
| virtual void | setVarDataBytes (int index, int length, DtDatumRetCode *retcode=NULL) |
| Allocates length bytes for the index'th variable datum record. More... | |
| virtual void | setDatumValFloat64 (DtDatumRecordType fixedOrVar, int index, DtFloat64 val, DtDatumRetCode *retcode=NULL) |
| ******* SETTING DATA VALUES BY INDEX ********* Use one of the following to set the data value in a fixed or variable datum record, depending on the data type of your data. More... | |
| virtual void | setDatumValFloat32 (DtDatumRecordType fixedOrVar, int index, DtFloat32 val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValInt32 (DtDatumRecordType fixedOrVar, int index, long val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValUnsigned32 (DtDatumRecordType fixedOrVar, int index, unsigned long val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValByteArray (DtDatumRecordType fixedOrVar, int index, const char *val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValFloat64 (DtDatumParam param, DtFloat64 val, DtDatumRetCode *retcode=NULL) |
| ****** SETTING DATA VALUES BY PARAM ID ********* Use one of the following to set the data value in a fixed or variable datum record, depending on the data type of your data. More... | |
| virtual void | setDatumValFloat32 (DtDatumParam param, DtFloat32 val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValInt32 (DtDatumParam param, long val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValUnsigned32 (DtDatumParam param, unsigned long val, DtDatumRetCode *retcode=NULL) |
| virtual void | setDatumValByteArray (DtDatumParam param, const char *val, DtDatumRetCode *retcode=NULL) |
| virtual void | printDataSection () const |
| Helper function that prints only the contents of the data records. More... | |
| virtual void | printDataSectionToStream (std::ostream &stream) const |
| Public Member Functions inherited from DtSimanPdu | |
| DtSimanPdu & | operator= (const DtSimanPdu &orig) |
| Assignment operator. More... | |
| virtual const DtEntityIdentifier & | senderId () const |
| Get the sender ID. More... | |
| virtual const DtEntityIdentifier & | receiverId () const |
| Get the receiver ID. More... | |
| virtual void | setSenderId (const DtEntityIdentifier &id) |
| Set the sender ID. More... | |
| virtual void | setReceiverId (const DtEntityIdentifier &id) |
| Set the receiver ID. More... | |
| Public Member Functions inherited from DtInteraction | |
| DtInteraction () | |
| default constructor More... | |
| virtual | ~DtInteraction () |
| destructor More... | |
| DtInteraction (const DtInteraction &orig) | |
| copy constructor More... | |
| DtInteraction & | operator= (const DtInteraction &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) |
| Create a DtActionRequestPdu. More... | |
| static void | addCallback (DtExerciseConn *conn, DtActionRequestInteractionCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. More... | |
| static void | removeCallback (DtExerciseConn *conn, DtActionRequestInteractionCb cb, void *usr) |
Protected Member Functions | |
| DtPduKind | internalGetPduKind () const |
| Returns the internal PDU kind. More... | |
| DtNetDataPduTail * | dataSection () const |
| Returns the data portion of the PDU. More... | |
| Protected Member Functions inherited from DtPduWithData | |
| virtual DtDatumRecordSet * | datumRecSet () |
| Returns our datum record set helper object. More... | |
| virtual const DtDatumRecordSet * | datumRecSet () const |
| Const version of above. More... | |
| virtual DtNetFixDatum * | nthFixedDataRecord (int index) const |
| Return a pointer to the index'th fixed data record in the network representation. More... | |
| virtual DtNetVarDatum * | nthVarDataRecord (int index) const |
| Return a pointer to the index'th variable data record in the network representation. More... | |
| virtual void * | datumValPtr (DtDatumRecordType fixedOrVar, int index) const |
| Returns a pointer to the index'th fixed or variable record in the network representation, depending on whether fixedOrVar is DtFIXED or DtVAR. 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 |
Instances of DtActionRequestPdu are used to send/receive action request PDUs.
| DtActionRequestPdu::DtActionRequestPdu | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
| DtActionRequestPdu::DtActionRequestPdu | ( | const DtNetActionRequestPdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER, |
||
| DtPduFactory * | pduFactory = 0 |
||
| ) |
| unsigned long DtActionRequestPdu::actionId | ( | ) | const |
Set/Get the action id.
|
static |
Add (register)/Remove (deregister) function to be called when pdu is received.
|
static |
Create a DtActionRequestPdu.
Caller is responsible for deletion.
|
protectedvirtual |
Returns the data portion of the PDU.
Implements DtPduWithData.
|
inlineprotectedvirtual |
|
virtual |
Print the data contained by this PDU.
Reimplemented from DtPduWithData.
|
virtual |
Print the data to a stream.
Reimplemented from DtPduWithData.
|
static |
| unsigned long DtActionRequestPdu::requestId | ( | ) | const |
Set/Get the request id.
| void DtActionRequestPdu::setActionId | ( | unsigned long | id | ) |
| void DtActionRequestPdu::setRequestId | ( | unsigned long | id | ) |
