 |
MAK Data Logger API Documentation for HLA
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
MAK Data Logger API Documentation for HLA
|
Inheritance diagram for MAKLogger::DtConstLgrHlaMessage: Collaboration diagram for MAKLogger::DtConstLgrHlaMessage:Public Member Functions | |
| DtConstLgrHlaMessage (const DtPacket *packet) | |
| CTOR for providing a HLA specific interface to a packet. More... | |
| DtConstLgrHlaMessage (const DtPacket &packet) | |
| CTOR for providing a HLA specific interface to a packet. More... | |
| virtual | ~DtConstLgrHlaMessage () |
| DTOR does nothing. More... | |
| bool | isUpdate () const |
| Is packet an Update message. More... | |
| bool | isMultiUpdate () const |
| Is packet an Update with multiple messages. More... | |
| bool | isDDMUpdate () const |
| Is packet an Update with DDM information. More... | |
| bool | isRemoval () const |
| Is packet a removal message. More... | |
| bool | isInteraction () const |
| Is packet an interaction message. More... | |
| DtLgrHlaHandle | objectHandle () const |
| Will throw if packet is not an update or removal. More... | |
| const DtString & | objectName () const |
| Will throw if packet is not an update or removal. More... | |
| const DtString & | asciiTag () const |
| Get tag as ascii string. More... | |
| const DtLgrVariableLengthData & | binaryTag () const |
| Get tag as binary data. More... | |
| DtTime | tagAsTimestamp () const |
| Get tag as timestamp. More... | |
| DtLgrHlaHandle | objectClassHandle () const |
| Will throw if packet is not an update,removal. More... | |
| DtLgrHlaHandle | interactionClassHandle () const |
| Will throw if packet is not an interaction;. More... | |
| bool | getInteractionRegionID (DtRegionID ®ionID, unsigned int index=0) const |
| Get the interaction region ID specified by the index. More... | |
| bool | getObjectRegionID (DtRegionID ®ionID, unsigned int index=0) const |
| Get the object region ID specified by the index. More... | |
| unsigned int | getObjectRegionIdSet (DtRegionIDSet ®ionIDSet) |
| Get the set of object region handles/names stored in this packet. More... | |
| unsigned int | getInteractionRegionIdSet (DtRegionIDSet ®ionIDSet) |
| Get the set of interaction region handles/names stored in this packet. More... | |
| std::auto_ptr < DtLgrHandleValueMap > | createAttrs () const |
| This will create a copy of the values. More... | |
| std::auto_ptr < DtLgrHandleValueMap > | createParams () const |
| Will throw if packet is not an interaction. More... | |
| std::auto_ptr < DtLgrHandleValueReferenceMap > | referenceAttrs () const |
| This will point to the values. More... | |
| std::auto_ptr < DtLgrHandleValueReferenceMap > | referenceParams () const |
| This will point to the values. More... | |
| DtDDMRegionSP | interactionDDMRegion (const DtExerciseConn *exerciseConn, unsigned int index=0, DtIDRegionMap *regionCache=0, bool updateRegion=false) const |
| Get an interaction region specified by the index Creates the region if cache is not supplied or region is not found. More... | |
| DtDDMRegionSP | objectDDMRegion (const DtExerciseConn *exerciseConn, unsigned int index=0, DtIDRegionMap *regionCache=0, bool updateRegion=false) const |
| Get the object region specified by index Creates the region if cache is not supplied or region is not found. More... | |
| unsigned int | getInteractionDDMRegionSet (const DtExerciseConn *exerciseConn, DtDDMRegionSet ®ionSet, DtIDRegionMap *regionCache=0, bool updateRegions=false) const |
| Get the region set. More... | |
| unsigned int | getObjectDDMRegionSet (const DtExerciseConn *exerciseConn, DtDDMRegionSet ®ionSet, DtIDRegionMap *regionCache=0, bool updateRegions=false) const |
| Get the region set. More... | |
| unsigned int | getInteractionDDMRegionDescSet (DtRegionDescSet ®ionSet) const |
| Get the region descriptor set. More... | |
| unsigned int | getObjectDDMRegionDescSet (DtRegionDescSet ®ionSet) const |
| Get the region descriptor set. More... | |
| DtInteraction * | createInteraction (DtInteractionFactory *factory, const DtLgrOnlineFomDesc &fom) const |
| DtLgrStateMsg * | createStateMsg (const DtLgrOnlineFomDesc &fom) const |
| Create a state message. More... | |
| DtLgrStateMsg ** | createMultiStateMsgs (const DtLgrOnlineFomDesc &fom, int &count) const |
| Create multiple state messages. More... | |
| void | paramHandles (std::vector< DtLgrHlaHandle > &) const |
| Will throw if packet is not an interaction. More... | |
| void | attrHandles (std::vector< DtLgrHlaHandle > &handles) const |
| Will throw if packet is not an update. More... | |
| const DtPacket * | packet () const |
Protected Attributes | |
| const DtPacket * | myConstPacket |
| DtString * | myObjectName |
| DtString * | myAsciiTag |
| DtLgrVariableLengthData * | myBinaryTag |
| bool | myGotTagTime |
| DtTime | myTagTime |
| MAKLogger::DtConstLgrHlaMessage::DtConstLgrHlaMessage | ( | const DtPacket * | packet | ) |
CTOR for providing a HLA specific interface to a packet.
| MAKLogger::DtConstLgrHlaMessage::DtConstLgrHlaMessage | ( | const DtPacket & | packet | ) |
CTOR for providing a HLA specific interface to a packet.
|
virtual |
DTOR does nothing.
| const DtString& MAKLogger::DtConstLgrHlaMessage::asciiTag | ( | ) | const |
Get tag as ascii string.
Will throw if packet is not an update or interaction.
| void MAKLogger::DtConstLgrHlaMessage::attrHandles | ( | std::vector< DtLgrHlaHandle > & | handles | ) | const |
Will throw if packet is not an update.
| const DtLgrVariableLengthData& MAKLogger::DtConstLgrHlaMessage::binaryTag | ( | ) | const |
Get tag as binary data.
| std::auto_ptr<DtLgrHandleValueMap> MAKLogger::DtConstLgrHlaMessage::createAttrs | ( | ) | const |
This will create a copy of the values.
Will throw if packet is not an update.
| DtInteraction* MAKLogger::DtConstLgrHlaMessage::createInteraction | ( | DtInteractionFactory * | factory, |
| const DtLgrOnlineFomDesc & | fom | ||
| ) | const |
| DtLgrStateMsg** MAKLogger::DtConstLgrHlaMessage::createMultiStateMsgs | ( | const DtLgrOnlineFomDesc & | fom, |
| int & | count | ||
| ) | const |
Create multiple state messages.
Will throw if packet is not a multi-time update.
| std::auto_ptr<DtLgrHandleValueMap> MAKLogger::DtConstLgrHlaMessage::createParams | ( | ) | const |
Will throw if packet is not an interaction.
| DtLgrStateMsg* MAKLogger::DtConstLgrHlaMessage::createStateMsg | ( | const DtLgrOnlineFomDesc & | fom | ) | const |
Create a state message.
Will throw if packet is not an update.
| unsigned int MAKLogger::DtConstLgrHlaMessage::getInteractionDDMRegionDescSet | ( | DtRegionDescSet & | regionSet | ) | const |
Get the region descriptor set.
Will throw if packet is not an interaction. Return the number of regions collected in the set
| unsigned int MAKLogger::DtConstLgrHlaMessage::getInteractionDDMRegionSet | ( | const DtExerciseConn * | exerciseConn, |
| DtDDMRegionSet & | regionSet, | ||
| DtIDRegionMap * | regionCache = 0, |
||
| bool | updateRegions = false |
||
| ) | const |
Get the region set.
Creates the region if cache is not supplied or region is not found. Regions found in cache are updated if region updating is enabled. Will throw if packet is not an interaction. Return the number of regions collected in the set
| bool MAKLogger::DtConstLgrHlaMessage::getInteractionRegionID | ( | DtRegionID & | regionID, |
| unsigned int | index = 0 |
||
| ) | const |
Get the interaction region ID specified by the index.
Return bool: region was in packet?
| unsigned int MAKLogger::DtConstLgrHlaMessage::getInteractionRegionIdSet | ( | DtRegionIDSet & | regionIDSet | ) |
Get the set of interaction region handles/names stored in this packet.
Return the number of regions collected
| unsigned int MAKLogger::DtConstLgrHlaMessage::getObjectDDMRegionDescSet | ( | DtRegionDescSet & | regionSet | ) | const |
Get the region descriptor set.
Will throw if packet is not an interaction. Return the number of regions collected in the set
| unsigned int MAKLogger::DtConstLgrHlaMessage::getObjectDDMRegionSet | ( | const DtExerciseConn * | exerciseConn, |
| DtDDMRegionSet & | regionSet, | ||
| DtIDRegionMap * | regionCache = 0, |
||
| bool | updateRegions = false |
||
| ) | const |
Get the region set.
Creates the region if cache is not supplied or region is not found. Regions found in cache are updated if region updating is enabled. Will throw if packet is not an update. Return the number of regions collected in the set
| bool MAKLogger::DtConstLgrHlaMessage::getObjectRegionID | ( | DtRegionID & | regionID, |
| unsigned int | index = 0 |
||
| ) | const |
Get the object region ID specified by the index.
Return bool: region was in packet?
| unsigned int MAKLogger::DtConstLgrHlaMessage::getObjectRegionIdSet | ( | DtRegionIDSet & | regionIDSet | ) |
Get the set of object region handles/names stored in this packet.
Return the number of regions collected
| DtLgrHlaHandle MAKLogger::DtConstLgrHlaMessage::interactionClassHandle | ( | ) | const |
Will throw if packet is not an interaction;.
| DtDDMRegionSP MAKLogger::DtConstLgrHlaMessage::interactionDDMRegion | ( | const DtExerciseConn * | exerciseConn, |
| unsigned int | index = 0, |
||
| DtIDRegionMap * | regionCache = 0, |
||
| bool | updateRegion = false |
||
| ) | const |
Get an interaction region specified by the index Creates the region if cache is not supplied or region is not found.
Region found in cache is updated if region updating is enabled. Will throw if packet is not an interaction.
| bool MAKLogger::DtConstLgrHlaMessage::isDDMUpdate | ( | ) | const |
Is packet an Update with DDM information.
| bool MAKLogger::DtConstLgrHlaMessage::isInteraction | ( | ) | const |
Is packet an interaction message.
| bool MAKLogger::DtConstLgrHlaMessage::isMultiUpdate | ( | ) | const |
Is packet an Update with multiple messages.
| bool MAKLogger::DtConstLgrHlaMessage::isRemoval | ( | ) | const |
Is packet a removal message.
| bool MAKLogger::DtConstLgrHlaMessage::isUpdate | ( | ) | const |
Is packet an Update message.
| DtLgrHlaHandle MAKLogger::DtConstLgrHlaMessage::objectClassHandle | ( | ) | const |
Will throw if packet is not an update,removal.
| DtDDMRegionSP MAKLogger::DtConstLgrHlaMessage::objectDDMRegion | ( | const DtExerciseConn * | exerciseConn, |
| unsigned int | index = 0, |
||
| DtIDRegionMap * | regionCache = 0, |
||
| bool | updateRegion = false |
||
| ) | const |
Get the object region specified by index Creates the region if cache is not supplied or region is not found.
Region found in cache is updated if region updating is enabled. Will throw if packet is not an update.
| DtLgrHlaHandle MAKLogger::DtConstLgrHlaMessage::objectHandle | ( | ) | const |
Will throw if packet is not an update or removal.
| const DtString& MAKLogger::DtConstLgrHlaMessage::objectName | ( | ) | const |
Will throw if packet is not an update or removal.
| const DtPacket* MAKLogger::DtConstLgrHlaMessage::packet | ( | ) | const |
| void MAKLogger::DtConstLgrHlaMessage::paramHandles | ( | std::vector< DtLgrHlaHandle > & | ) | const |
Will throw if packet is not an interaction.
| std::auto_ptr<DtLgrHandleValueReferenceMap> MAKLogger::DtConstLgrHlaMessage::referenceAttrs | ( | ) | const |
This will point to the values.
This map will need to be deallocated. Will throw if packet is not an update.
| std::auto_ptr<DtLgrHandleValueReferenceMap> MAKLogger::DtConstLgrHlaMessage::referenceParams | ( | ) | const |
This will point to the values.
This map will need to be deallocated. Will throw if packet is not an update.
| DtTime MAKLogger::DtConstLgrHlaMessage::tagAsTimestamp | ( | ) | const |
Get tag as timestamp.
|
mutableprotected |
|
mutableprotected |
|
protected |
|
mutableprotected |
|
mutableprotected |
|
mutableprotected |
