 |
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
|
DtSimanPdu provides a base class for all of the simulation management PDU's. More...
Inheritance diagram for DtSimanPdu: Collaboration diagram for DtSimanPdu:Public Member Functions | |
| 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. | |
| virtual void | printData () const |
| Prints the contents of the PDU. | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Prints the contents of the PDU to the specified stream. | |
| 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. | |
Protected Attributes | |
| DtEntityIdentifier | mySenderId |
| DtEntityIdentifier | myReceiverId |
Additional Inherited Members | |
| Protected Member Functions inherited from DtPduWithAttributeRecordSets | |
| virtual void | deepAttributeRecordSetMapCopy (const DtAttributeRecordSetMap &orig) |
| Performs a deep copy. | |
| virtual void | printRecordSetToStream (const DtEntityIdentifier &id, std::ostream &stream) const |
| virtual bool | shouldAttributePduBeCoupled () |
DtSimanPdu provides a base class for all of the simulation management PDU's.
|
inline |
Assignment operator.
References DtPdu::operator=().
|
virtual |
Prints the contents of the PDU.
Reimplemented from DtPdu.
Reimplemented in DtPduWithData, DtActionResponsePdu, DtStopFreezePdu, DtDataQueryRPdu, DtStopFreezeRPdu, DtStartResumePdu, DtDataQueryPdu, DtActionRequestPdu, DtStartResumeRPdu, DtAcknowledgePdu, DtCreateEntityPdu, DtAcknowledgeRPdu, DtActionRequestRPdu, DtCreateEntityRPdu, DtSetDataPdu, DtRemoveEntityRPdu, DtDataRPdu, DtSetDataRPdu, DtActionResponseRPdu, DtRemoveEntityPdu, DtDataPdu, DtEventReportPdu, and DtEventReptRPdu.
|
virtual |
Prints the contents of the PDU to the specified stream.
Reimplemented from DtPdu.
Reimplemented in DtPduWithData, DtActionResponsePdu, DtStopFreezePdu, DtDataQueryRPdu, DtStopFreezeRPdu, DtStartResumePdu, DtDataQueryPdu, DtActionRequestPdu, DtStartResumeRPdu, DtAcknowledgePdu, DtCreateEntityPdu, DtAcknowledgeRPdu, DtActionRequestRPdu, DtCreateEntityRPdu, DtSetDataPdu, DtRemoveEntityRPdu, DtDataRPdu, DtSetDataRPdu, DtActionResponseRPdu, DtRemoveEntityPdu, DtDataPdu, DtEventReportPdu, and DtEventReptRPdu.
|
virtual |
Get the receiver ID.
|
virtual |
Get the sender ID.
|
virtual |
Set the receiver ID.
|
virtual |
Set the sender ID.
|
mutableprotected |
|
mutableprotected |
