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 Types | Protected Member Functions | Protected Attributes
MAKLogger::DtLgrOnlineFomDesc Class Reference

An online fom description that has access to the RTI Ambassidor. More...

+ Inheritance diagram for MAKLogger::DtLgrOnlineFomDesc:
+ Collaboration diagram for MAKLogger::DtLgrOnlineFomDesc:

Public Member Functions

 DT_VIRTUAL_CTR_DEFAULTS (DtLgrOnlineFomDesc,(DtExerciseConn *exconn, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *heartbeatTimes, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *timeoutTimes),(DtExerciseConn *exconn, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *heartbeatTimes=0, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *timeoutTimes=0)) virtual ~DtLgrOnlineFomDesc()
 Virtual Constructor. More...
 
RTI::RTIambassador *const rtiAmb () const
 Get the RTI ambassador. More...
 
virtual DtBaseObjClassDescaddObjectClass (const DtBaseObjClassDesc &)
 Add an object class. More...
 
virtual DtBaseInterClassDescaddInteractionClass (const DtBaseInterClassDesc &)
 Add an interaction class. More...
 
virtual bool isEntity (RTI::ObjectClassHandle handle) const
 Lookup to see if object is entity. More...
 
virtual bool isAggregate (RTI::ObjectClassHandle handle) const
 Lookup to see if object is aggregate. More...
 
virtual double heartbeatTime (RTI::ObjectClassHandle handle) const
 Lookup to see object's heartbeat interval. More...
 
virtual double timeoutTime (RTI::ObjectClassHandle handle) const
 Lookup to see object's timeout interval. More...
 
virtual DtBaseObjClassDescobjDesc (RTI::ObjectClassHandle)
 Return the class descriptor for an object RTI handle. More...
 
virtual const DtBaseObjClassDescobjDesc (RTI::ObjectClassHandle) const
 Return the class descriptor for an object RTI handle. More...
 
virtual DtBaseInterClassDescinterDesc (RTI::InteractionClassHandle)
 Return the class descriptor for an RTI handle. More...
 
virtual const
DtBaseInterClassDesc
interDesc (RTI::InteractionClassHandle) const
 Return the class descriptor for an RTI handle. More...
 
- Public Member Functions inherited from MAKLogger::DtBaseFomDesc
virtual ~DtBaseFomDesc ()
 Virtual Constructor. More...
 
virtual int readFromFile (FILE *fp)
 Initialize by reading FOM from a logger file. More...
 
virtual int readFromFile64 (int fd)
 
virtual int writeToFile (FILE *fp) const
 Write contents to a logger file. More...
 
virtual int writeToFile64 (int fd) const
 
virtual int setFromSerialForm (const void *p)
 Initialize by reading FOM from a "serialized-form" buffer. More...
 
virtual char * serialize (int *pSize=0) const
 Obtain a copy of the current fom in serialized form. More...
 
int objectClassCount () const
 Get the number of object classes in the FOM. More...
 
int interactionClassCount () const
 Get the number of interaction classes in the FOM. More...
 
int count () const
 Get the total number of classes in the FOM (object and interaction) More...
 
virtual bool equivalent (const DtBaseFomDesc &other) const
 Returns true if we represent an equivalent FOM to other. More...
 
virtual bool identical (const DtBaseFomDesc &other) const
 Returns true if we are identical FOMs including the handles. More...
 
virtual void setFilterByClass (const DtSubscriptionMap *map)
 Set the current "Filter-By-Class" Map. More...
 
virtual void setFilterAllObjectClasses ()
 Filter all object. More...
 
virtual void setFilterNoObjectClasses ()
 Filter no objects. More...
 
virtual void setFilterAllInteractionClasses ()
 Filter all interactions. More...
 
virtual void setFilterNoInteractionClasses ()
 Filter no interactions. More...
 
virtual void empty ()
 Reset the current data (note: erases everything!) More...
 
virtual void setObjectClassHeartbeatTime (const DtString &className, double time, bool includeSubclasses=false)
 Set the heartbeat period for the specified object class. More...
 
virtual bool getObjectClassHeartbeatTime (const DtString &className, double &heartbeat) const
 Get the heartbeat period for the specified object class Return bool: heartbeat of the specified class was found? More...
 
virtual bool objectClassHeartbeatInheritable (const DtString &className) const
 Return whether the heartbeat period for the specified class is inheritable. More...
 
virtual void setObjectClassTimeoutTime (const DtString &className, double time, bool includeSubclasses=false)
 Set the timeout period for the specified object class. More...
 
virtual bool getObjectClassTimeoutTime (const DtString &className, double &timeout) const
 Get the timeout period for the specified object class Return bool: timeout of the specified class was found? More...
 
virtual bool objectClassTimeoutInheritable (const DtString &className) const
 Return whether the timeout period for the specified class is inheritable. More...
 
objectIterator obj_begin ()
 Get the iterator to the first object class. More...
 
const_objectIterator obj_begin () const
 Get the iterator to the first object class. More...
 
objectIterator obj_end ()
 Get the iterator beyond the last object class. More...
 
const_objectIterator obj_end () const
 Get the iterator beyond the last object class. More...
 
interactionIterator inter_begin ()
 Get the iterator to the first interaction class. More...
 
const_interactionIterator inter_begin () const
 Get the iterator to the first interaction class. More...
 
interactionIterator inter_end ()
 Get the iterator beyond the last interaction class. More...
 
const_interactionIterator inter_end () const
 Get the iterator beyond the last interaction class. More...
 
virtual DtBaseObjClassDescobjDesc (unsigned int hand)
 Return the class descriptor for an object class handle. More...
 
virtual const DtBaseObjClassDescobjDesc (unsigned int hand) const
 Return the class descriptor for an object class handle. More...
 
virtual DtBaseObjClassDescobjDesc (const DtString &_name)
 Return the class descriptor for an object class name. More...
 
virtual const DtBaseObjClassDescobjDesc (const DtString &_name) const
 Return the class descriptor for an object class name. More...
 
virtual DtBaseInterClassDescinterDesc (unsigned int hand)
 Return the class descriptor for an interaction class handle. More...
 
virtual const
DtBaseInterClassDesc
interDesc (unsigned int hand) const
 Return the class descriptor for an interaction class handle. More...
 
virtual DtBaseInterClassDescinterDesc (const DtString &_name)
 Return the class descriptor for an interaction class name. More...
 
virtual const
DtBaseInterClassDesc
interDesc (const DtString &_name) const
 Return the class descriptor for an interaction class name. More...
 
virtual void initObjClasses ()
 These functions complete the initialization of the object and interaction classes; i.e., they effect the proper referencing of a base class inside an object or interaction class. More...
 
virtual void initIntClasses ()
 These functions complete the initialization of the object and interaction classes; i.e., they effect the proper referencing of a base class inside an object or interaction class. More...
 

Protected Types

typedef std::map
< DtLgrVariableLengthData,
DtBaseObjClassDesc * > 
ObjectCodeMap
 
typedef std::map
< DtLgrVariableLengthData,
DtBaseInterClassDesc * > 
InteractionCodeMap
 
typedef std::set
< RTI::ObjectClassHandle > 
DtHandleSet
 
- Protected Types inherited from MAKLogger::DtBaseFomDesc
typedef DtMultiKeyMap
< DtString, DtLgrHlaHandle,
DtBaseObjClassDesc * > 
ObjectMap
 
typedef DtMultiKeyMap
< DtString, DtLgrHlaHandle,
DtBaseInterClassDesc * > 
InteractionMap
 

Protected Member Functions

void setFomMapperLists (DtFomMapper *)
 Set fom mapper lists from exconn. More...
 
void setFromFom (DtFom &fom)
 Initialize from a VR-Link FOM object. More...
 
virtual void deleteObjClasses ()
 Delete all internal object class information. More...
 
virtual void deleteIntClasses ()
 Delete all internal interaction class information. More...
 
void addObjectFromFom (DtObjClassDesc *dsc, DtDynamicBuffer &dynBfr, DtLgrHlaHandle objectHandle)
 Adds an object from a fom. More...
 
void addInteractionFromFom (DtInterClassDesc *item, DtDynamicBuffer &dynBfr, DtLgrHlaHandle interHandle)
 Adds an interaction from a fom. More...
 
void addAttributeFromFom (RTI::AttributeHandleSet::const_iterator attrIter, RTI::ObjectClassHandle classHandle, DtDynamicBuffer &dynBfr, unsigned long lgrAttrHandle, DtBaseObjClassDesc *objDsc)
 Adds an object attribute from a fom. More...
 
void addParameterFromFom (RTI::ParameterHandleSet::const_iterator paramIter, RTI::InteractionClassHandle classHandle, DtDynamicBuffer &dynBfr, unsigned long lgrParamHandle, DtBaseInterClassDesc *intDsc)
 Adds an interaction parameter from a fom. More...
 
- Protected Member Functions inherited from MAKLogger::DtBaseFomDesc
bool processCommand (const char *command, char *tkn, const char *sep)
 Process command while reading file. More...
 
void resetAll ()
 Delete all internal class information. More...
 
void initFromSource (const DtBaseFomDesc &src)
 to duplicate fom description. More...
 
int unserialize (const char *bfr)
 Deserialize from buffer. More...
 

Protected Attributes

ObjectCodeMap myObjectCodeLookupMap
 
InteractionCodeMap myInteractionCodeLookupMap
 
DtHandleSet myEntityClassHandles
 
DtHandleSet myAggregateClassHandles
 
std::map
< RTI::ObjectClassHandle,
double > 
myHandleHeartbeats
 
std::map
< RTI::ObjectClassHandle,
double > 
myHandleTimeouts
 
RTI::RTIambassador * myRtiAmb
 
- Protected Attributes inherited from MAKLogger::DtBaseFomDesc
ObjectMap myObjectLookupMap
 
InteractionMap myInteractionLookupMap
 
std::vector< DtBaseObjClassDesc * > myObjectClasses
 
std::vector
< DtBaseInterClassDesc * > 
myInteractionClasses
 
std::map< DtString,
DtLgrSimDriver::HeartbeatTimeRecord
myHeartbeatTimes
 
std::map< DtString,
DtLgrSimDriver::HeartbeatTimeRecord
myTimeoutTimes
 

Additional Inherited Members

- Public Types inherited from MAKLogger::DtBaseFomDesc
typedef std::vector
< DtBaseObjClassDesc * >
::iterator 
objectIterator
 
typedef std::vector
< DtBaseObjClassDesc * >
::const_iterator 
const_objectIterator
 
typedef std::vector
< DtBaseInterClassDesc * >
::iterator 
interactionIterator
 
typedef std::vector
< DtBaseInterClassDesc * >
::const_iterator 
const_interactionIterator
 
- Static Protected Attributes inherited from MAKLogger::DtBaseFomDesc
static int theHashSize
 

Detailed Description

An online fom description that has access to the RTI Ambassidor.

This class is only safe to use in the same thread as the ExerciseConnection.

Member Typedef Documentation

typedef std::set<RTI::ObjectClassHandle> MAKLogger::DtLgrOnlineFomDesc::DtHandleSet
protected

Member Function Documentation

void MAKLogger::DtLgrOnlineFomDesc::addAttributeFromFom ( RTI::AttributeHandleSet::const_iterator  attrIter,
RTI::ObjectClassHandle  classHandle,
DtDynamicBuffer dynBfr,
unsigned long  lgrAttrHandle,
DtBaseObjClassDesc objDsc 
)
protected

Adds an object attribute from a fom.

virtual DtBaseInterClassDesc* MAKLogger::DtLgrOnlineFomDesc::addInteractionClass ( const DtBaseInterClassDesc )
virtual

Add an interaction class.

Reimplemented from MAKLogger::DtBaseFomDesc.

void MAKLogger::DtLgrOnlineFomDesc::addInteractionFromFom ( DtInterClassDesc *  item,
DtDynamicBuffer dynBfr,
DtLgrHlaHandle  interHandle 
)
protected

Adds an interaction from a fom.

virtual DtBaseObjClassDesc* MAKLogger::DtLgrOnlineFomDesc::addObjectClass ( const DtBaseObjClassDesc )
virtual

Add an object class.

Reimplemented from MAKLogger::DtBaseFomDesc.

void MAKLogger::DtLgrOnlineFomDesc::addObjectFromFom ( DtObjClassDesc *  dsc,
DtDynamicBuffer dynBfr,
DtLgrHlaHandle  objectHandle 
)
protected

Adds an object from a fom.

void MAKLogger::DtLgrOnlineFomDesc::addParameterFromFom ( RTI::ParameterHandleSet::const_iterator  paramIter,
RTI::InteractionClassHandle  classHandle,
DtDynamicBuffer dynBfr,
unsigned long  lgrParamHandle,
DtBaseInterClassDesc intDsc 
)
protected

Adds an interaction parameter from a fom.

virtual void MAKLogger::DtLgrOnlineFomDesc::deleteIntClasses ( )
protectedvirtual

Delete all internal interaction class information.

Reimplemented from MAKLogger::DtBaseFomDesc.

virtual void MAKLogger::DtLgrOnlineFomDesc::deleteObjClasses ( )
protectedvirtual

Delete all internal object class information.

Reimplemented from MAKLogger::DtBaseFomDesc.

MAKLogger::DtLgrOnlineFomDesc::DT_VIRTUAL_CTR_DEFAULTS ( DtLgrOnlineFomDesc  ,
(DtExerciseConn *exconn, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *heartbeatTimes, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *timeoutTimes)  ,
(DtExerciseConn *exconn, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *heartbeatTimes=0, const std::map< DtString, DtLgrSimDriver::HeartbeatTimeRecord > *timeoutTimes=0)   
)

Virtual Constructor.

Virtual copy and assignment operator.

virtual double MAKLogger::DtLgrOnlineFomDesc::heartbeatTime ( RTI::ObjectClassHandle  handle) const
virtual

Lookup to see object's heartbeat interval.

virtual DtBaseInterClassDesc* MAKLogger::DtLgrOnlineFomDesc::interDesc ( RTI::InteractionClassHandle  )
virtual

Return the class descriptor for an RTI handle.

virtual const DtBaseInterClassDesc* MAKLogger::DtLgrOnlineFomDesc::interDesc ( RTI::InteractionClassHandle  ) const
virtual

Return the class descriptor for an RTI handle.

virtual bool MAKLogger::DtLgrOnlineFomDesc::isAggregate ( RTI::ObjectClassHandle  handle) const
virtual

Lookup to see if object is aggregate.

virtual bool MAKLogger::DtLgrOnlineFomDesc::isEntity ( RTI::ObjectClassHandle  handle) const
virtual

Lookup to see if object is entity.

virtual DtBaseObjClassDesc* MAKLogger::DtLgrOnlineFomDesc::objDesc ( RTI::ObjectClassHandle  )
virtual

Return the class descriptor for an object RTI handle.

virtual const DtBaseObjClassDesc* MAKLogger::DtLgrOnlineFomDesc::objDesc ( RTI::ObjectClassHandle  ) const
virtual

Return the class descriptor for an object RTI handle.

RTI::RTIambassador *const MAKLogger::DtLgrOnlineFomDesc::rtiAmb ( ) const
inline

Get the RTI ambassador.

References myRtiAmb.

void MAKLogger::DtLgrOnlineFomDesc::setFomMapperLists ( DtFomMapper *  )
protected

Set fom mapper lists from exconn.

void MAKLogger::DtLgrOnlineFomDesc::setFromFom ( DtFom fom)
protected

Initialize from a VR-Link FOM object.

virtual double MAKLogger::DtLgrOnlineFomDesc::timeoutTime ( RTI::ObjectClassHandle  handle) const
virtual

Lookup to see object's timeout interval.

Member Data Documentation

DtHandleSet MAKLogger::DtLgrOnlineFomDesc::myAggregateClassHandles
protected
DtHandleSet MAKLogger::DtLgrOnlineFomDesc::myEntityClassHandles
protected
std::map<RTI::ObjectClassHandle, double> MAKLogger::DtLgrOnlineFomDesc::myHandleHeartbeats
protected
std::map<RTI::ObjectClassHandle, double> MAKLogger::DtLgrOnlineFomDesc::myHandleTimeouts
protected
InteractionCodeMap MAKLogger::DtLgrOnlineFomDesc::myInteractionCodeLookupMap
protected
ObjectCodeMap MAKLogger::DtLgrOnlineFomDesc::myObjectCodeLookupMap
protected
RTI::RTIambassador* MAKLogger::DtLgrOnlineFomDesc::myRtiAmb
protected

Referenced by rtiAmb().


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)