MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
MAKLogger::DtLgrHlaMessage Class Reference
+ Inheritance diagram for MAKLogger::DtLgrHlaMessage:
+ Collaboration diagram for MAKLogger::DtLgrHlaMessage:

Public Member Functions

 DtLgrHlaMessage (DtPacket *packet)
 CTOR for providing a HLA specific interface to a packet. More...
 
virtual ~DtLgrHlaMessage ()
 DTOR does nothing. More...
 
void setObjectHandle (DtLgrHlaHandle handle)
 Overwrite the object handle. More...
 
void setObjectClassHandle (DtLgrHlaHandle handle)
 Overwrite the class handle. More...
 
void setInteractionClassHandle (DtLgrHlaHandle handle)
 Overwrite the class handle. More...
 
std::auto_ptr
< DtLgrHandleValueReferenceMap
referenceAttrs ()
 Will throw if packet is not an update. More...
 
std::auto_ptr
< DtLgrHandleValueReferenceMap
referenceParams ()
 Will throw if packet is not an update. More...
 
void setParamHandles (const std::vector< DtLgrHlaHandle > &)
 Will throw if packet is not an interaction. More...
 
void setAttrHandles (const std::vector< DtLgrHlaHandle > &handles)
 Will throw if packet is not an update. More...
 
- Public Member Functions inherited from MAKLogger::DtConstLgrHlaMessage
 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 DtStringobjectName () const
 Will throw if packet is not an update or removal. More...
 
const DtStringasciiTag () const
 Get tag as ascii string. More...
 
const DtLgrVariableLengthDatabinaryTag () 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 &regionID, unsigned int index=0) const
 Get the interaction region ID specified by the index. More...
 
bool getObjectRegionID (DtRegionID &regionID, unsigned int index=0) const
 Get the object region ID specified by the index. More...
 
unsigned int getObjectRegionIdSet (DtRegionIDSet &regionIDSet)
 Get the set of object region handles/names stored in this packet. More...
 
unsigned int getInteractionRegionIdSet (DtRegionIDSet &regionIDSet)
 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 &regionSet, DtIDRegionMap *regionCache=0, bool updateRegions=false) const
 Get the region set. More...
 
unsigned int getObjectDDMRegionSet (const DtExerciseConn *exerciseConn, DtDDMRegionSet &regionSet, DtIDRegionMap *regionCache=0, bool updateRegions=false) const
 Get the region set. More...
 
unsigned int getInteractionDDMRegionDescSet (DtRegionDescSet &regionSet) const
 Get the region descriptor set. More...
 
unsigned int getObjectDDMRegionDescSet (DtRegionDescSet &regionSet) const
 Get the region descriptor set. More...
 
DtInteractioncreateInteraction (DtInteractionFactory *factory, const DtLgrOnlineFomDesc &fom) const
 
DtLgrStateMsgcreateStateMsg (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 DtPacketpacket () const
 

Protected Attributes

DtPacketmyPacket
 
- Protected Attributes inherited from MAKLogger::DtConstLgrHlaMessage
const DtPacketmyConstPacket
 
DtStringmyObjectName
 
DtStringmyAsciiTag
 
DtLgrVariableLengthDatamyBinaryTag
 
bool myGotTagTime
 
DtTime myTagTime
 

Constructor & Destructor Documentation

MAKLogger::DtLgrHlaMessage::DtLgrHlaMessage ( DtPacket packet)

CTOR for providing a HLA specific interface to a packet.

virtual MAKLogger::DtLgrHlaMessage::~DtLgrHlaMessage ( )
virtual

DTOR does nothing.

Member Function Documentation

std::auto_ptr<DtLgrHandleValueReferenceMap> MAKLogger::DtLgrHlaMessage::referenceAttrs ( )

Will throw if packet is not an update.

This will point to the values. This map will need to be deallocated.

std::auto_ptr<DtLgrHandleValueReferenceMap> MAKLogger::DtLgrHlaMessage::referenceParams ( )

Will throw if packet is not an update.

This will point to the values. This map will need to be deallocated.

void MAKLogger::DtLgrHlaMessage::setAttrHandles ( const std::vector< DtLgrHlaHandle > &  handles)

Will throw if packet is not an update.

void MAKLogger::DtLgrHlaMessage::setInteractionClassHandle ( DtLgrHlaHandle  handle)

Overwrite the class handle.

Will throw if packet is not an update,removal or interaction;

void MAKLogger::DtLgrHlaMessage::setObjectClassHandle ( DtLgrHlaHandle  handle)

Overwrite the class handle.

Will throw if packet is not an update,removal or interaction;

void MAKLogger::DtLgrHlaMessage::setObjectHandle ( DtLgrHlaHandle  handle)

Overwrite the object handle.

Will throw if packet is not an update or removal.

void MAKLogger::DtLgrHlaMessage::setParamHandles ( const std::vector< DtLgrHlaHandle > &  )

Will throw if packet is not an interaction.

Member Data Documentation

DtPacket* MAKLogger::DtLgrHlaMessage::myPacket
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)