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

class DtBaseFomDesc: More...

+ Inheritance diagram for MAKLogger::DtBaseFomDesc:
+ Collaboration diagram for MAKLogger::DtBaseFomDesc:

Public Types

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

Public Member Functions

virtual ~DtBaseFomDesc ()
 Virtual Constructor.
virtual DtBaseObjClassDescaddObjectClass (const DtBaseObjClassDesc &)
virtual DtBaseInterClassDescaddInteractionClass (const DtBaseInterClassDesc &)
virtual int readFromFile (FILE *fp)
 Initialize by reading FOM from a logger file.
virtual int readFromFile64 (int fd)
virtual int writeToFile (FILE *fp) const
 Write contents to a logger file.
virtual int writeToFile64 (int fd) const
virtual int setFromSerialForm (const void *p)
 Initialize by reading FOM from a "serialized-form" buffer.
virtual char * serialize (int *pSize=0) const
 Obtain a copy of the current fom in serialized form.
int objectClassCount () const
 Get the number of object classes in the FOM.
int interactionClassCount () const
 Get the number of interaction classes in the FOM.
int count () const
 Get the total number of classes in the FOM (object and interaction)
virtual bool equivalent (const DtBaseFomDesc &other) const
 Returns true if we represent an equivalent FOM to other.
virtual bool identical (const DtBaseFomDesc &other) const
 Returns true if we are identical FOMs including the handles.
virtual void setFilterByClass (const DtSubscriptionMap *map)
 Set the current "Filter-By-Class" Map.
virtual void setFilterAllObjectClasses ()
 Filter all object.
virtual void setFilterNoObjectClasses ()
 Filter no objects.
virtual void setFilterAllInteractionClasses ()
 Filter all interactions.
virtual void setFilterNoInteractionClasses ()
 Filter no interactions.
virtual void empty ()
 Reset the current data (note: erases everything!)
virtual void setObjectClassHeartbeatTime (const DtString &className, double time, bool includeSubclasses=false)
 Set the heartbeat period for the specified object class.
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?
virtual bool objectClassHeartbeatInheritable (const DtString &className) const
 Return whether the heartbeat period for the specified class is inheritable.
virtual void setObjectClassTimeoutTime (const DtString &className, double time, bool includeSubclasses=false)
 Set the timeout period for the specified object class.
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?
virtual bool objectClassTimeoutInheritable (const DtString &className) const
 Return whether the timeout period for the specified class is inheritable.
objectIterator obj_begin ()
 Get the iterator to the first object class.
const_objectIterator obj_begin () const
 Get the iterator to the first object class.
objectIterator obj_end ()
 Get the iterator beyond the last object class.
const_objectIterator obj_end () const
 Get the iterator beyond the last object class.
interactionIterator inter_begin ()
 Get the iterator to the first interaction class.
const_interactionIterator inter_begin () const
 Get the iterator to the first interaction class.
interactionIterator inter_end ()
 Get the iterator beyond the last interaction class.
const_interactionIterator inter_end () const
 Get the iterator beyond the last interaction class.
virtual DtBaseObjClassDescobjDesc (unsigned int hand)
 Return the class descriptor for an object class handle.
virtual const DtBaseObjClassDescobjDesc (unsigned int hand) const
 Return the class descriptor for an object class handle.
virtual DtBaseObjClassDescobjDesc (const DtString &_name)
 Return the class descriptor for an object class name.
virtual const DtBaseObjClassDescobjDesc (const DtString &_name) const
 Return the class descriptor for an object class name.
virtual DtBaseInterClassDescinterDesc (unsigned int hand)
 Return the class descriptor for an interaction class handle.
virtual const
DtBaseInterClassDesc
interDesc (unsigned int hand) const
 Return the class descriptor for an interaction class handle.
virtual DtBaseInterClassDescinterDesc (const DtString &_name)
 Return the class descriptor for an interaction class name.
virtual const
DtBaseInterClassDesc
interDesc (const DtString &_name) const
 Return the class descriptor for an interaction class name.
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.
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.

Protected Types

typedef DtMultiKeyMap
< DtString, DtLgrHlaHandle,
DtBaseObjClassDesc * > 
ObjectMap
typedef DtMultiKeyMap
< DtString, DtLgrHlaHandle,
DtBaseInterClassDesc * > 
InteractionMap

Protected Member Functions

bool processCommand (const char *command, char *tkn, const char *sep)
 Process command while reading file.
virtual void deleteObjClasses ()
 Delete all internal object class information.
virtual void deleteIntClasses ()
 Delete all internal interaction class information.
void resetAll ()
 Delete all internal class information.
void initFromSource (const DtBaseFomDesc &src)
 to duplicate fom description.
int unserialize (const char *bfr)
 Deserialize from buffer.

Protected Attributes

ObjectMap myObjectLookupMap
InteractionMap myInteractionLookupMap
std::vector< DtBaseObjClassDesc * > myObjectClasses
std::vector
< DtBaseInterClassDesc * > 
myInteractionClasses
std::map< DtString,
DtLgrSimDriver::HeartbeatTimeRecord
myHeartbeatTimes
std::map< DtString,
DtLgrSimDriver::HeartbeatTimeRecord
myTimeoutTimes

Static Protected Attributes

static int theHashSize

Detailed Description

class DtBaseFomDesc:

Instances of DtBaseFomDesc provide mappings between class names and handles in HLA

Member Typedef Documentation

Constructor & Destructor Documentation

virtual MAKLogger::DtBaseFomDesc::~DtBaseFomDesc ( )
virtual

Virtual Constructor.

Virtual copy and assignment operator.

Member Function Documentation

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

Reimplemented in MAKLogger::DtLgrOnlineFomDesc.

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

Reimplemented in MAKLogger::DtLgrOnlineFomDesc.

int MAKLogger::DtBaseFomDesc::count ( ) const
inline

Get the total number of classes in the FOM (object and interaction)

References interactionClassCount(), and objectClassCount().

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

Delete all internal interaction class information.

Reimplemented in MAKLogger::DtLgrOnlineFomDesc.

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

Delete all internal object class information.

Reimplemented in MAKLogger::DtLgrOnlineFomDesc.

virtual void MAKLogger::DtBaseFomDesc::empty ( )
virtual

Reset the current data (note: erases everything!)

virtual bool MAKLogger::DtBaseFomDesc::equivalent ( const DtBaseFomDesc other) const
virtual

Returns true if we represent an equivalent FOM to other.

virtual bool MAKLogger::DtBaseFomDesc::getObjectClassHeartbeatTime ( const DtString className,
double &  heartbeat 
) const
virtual

Get the heartbeat period for the specified object class Return bool: heartbeat of the specified class was found?

virtual bool MAKLogger::DtBaseFomDesc::getObjectClassTimeoutTime ( const DtString className,
double &  timeout 
) const
virtual

Get the timeout period for the specified object class Return bool: timeout of the specified class was found?

virtual bool MAKLogger::DtBaseFomDesc::identical ( const DtBaseFomDesc other) const
virtual

Returns true if we are identical FOMs including the handles.

void MAKLogger::DtBaseFomDesc::initFromSource ( const DtBaseFomDesc src)
protected

to duplicate fom description.

virtual void MAKLogger::DtBaseFomDesc::initIntClasses ( )
virtual

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.

Call these functions when the fom object contains all of its object/interaction classes

virtual void MAKLogger::DtBaseFomDesc::initObjClasses ( )
virtual

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.

Call these functions when the fom object contains all of its object/interaction classes

interactionIterator MAKLogger::DtBaseFomDesc::inter_begin ( )

Get the iterator to the first interaction class.

const_interactionIterator MAKLogger::DtBaseFomDesc::inter_begin ( ) const

Get the iterator to the first interaction class.

interactionIterator MAKLogger::DtBaseFomDesc::inter_end ( )

Get the iterator beyond the last interaction class.

const_interactionIterator MAKLogger::DtBaseFomDesc::inter_end ( ) const

Get the iterator beyond the last interaction class.

int MAKLogger::DtBaseFomDesc::interactionClassCount ( ) const
inline

Get the number of interaction classes in the FOM.

References myInteractionClasses.

Referenced by count().

virtual DtBaseInterClassDesc* MAKLogger::DtBaseFomDesc::interDesc ( unsigned int  hand)
virtual

Return the class descriptor for an interaction class handle.

virtual const DtBaseInterClassDesc* MAKLogger::DtBaseFomDesc::interDesc ( unsigned int  hand) const
virtual

Return the class descriptor for an interaction class handle.

virtual DtBaseInterClassDesc* MAKLogger::DtBaseFomDesc::interDesc ( const DtString _name)
virtual

Return the class descriptor for an interaction class name.

virtual const DtBaseInterClassDesc* MAKLogger::DtBaseFomDesc::interDesc ( const DtString _name) const
virtual

Return the class descriptor for an interaction class name.

objectIterator MAKLogger::DtBaseFomDesc::obj_begin ( )

Get the iterator to the first object class.

const_objectIterator MAKLogger::DtBaseFomDesc::obj_begin ( ) const

Get the iterator to the first object class.

objectIterator MAKLogger::DtBaseFomDesc::obj_end ( )

Get the iterator beyond the last object class.

const_objectIterator MAKLogger::DtBaseFomDesc::obj_end ( ) const

Get the iterator beyond the last object class.

virtual DtBaseObjClassDesc* MAKLogger::DtBaseFomDesc::objDesc ( unsigned int  hand)
virtual

Return the class descriptor for an object class handle.

virtual const DtBaseObjClassDesc* MAKLogger::DtBaseFomDesc::objDesc ( unsigned int  hand) const
virtual

Return the class descriptor for an object class handle.

virtual DtBaseObjClassDesc* MAKLogger::DtBaseFomDesc::objDesc ( const DtString _name)
virtual

Return the class descriptor for an object class name.

virtual const DtBaseObjClassDesc* MAKLogger::DtBaseFomDesc::objDesc ( const DtString _name) const
virtual

Return the class descriptor for an object class name.

int MAKLogger::DtBaseFomDesc::objectClassCount ( ) const
inline

Get the number of object classes in the FOM.

References myObjectClasses.

Referenced by count().

virtual bool MAKLogger::DtBaseFomDesc::objectClassHeartbeatInheritable ( const DtString className) const
virtual

Return whether the heartbeat period for the specified class is inheritable.

virtual bool MAKLogger::DtBaseFomDesc::objectClassTimeoutInheritable ( const DtString className) const
virtual

Return whether the timeout period for the specified class is inheritable.

bool MAKLogger::DtBaseFomDesc::processCommand ( const char *  command,
char *  tkn,
const char *  sep 
)
protected

Process command while reading file.

virtual int MAKLogger::DtBaseFomDesc::readFromFile ( FILE *  fp)
virtual

Initialize by reading FOM from a logger file.

virtual int MAKLogger::DtBaseFomDesc::readFromFile64 ( int  fd)
virtual
void MAKLogger::DtBaseFomDesc::resetAll ( )
protected

Delete all internal class information.

virtual char* MAKLogger::DtBaseFomDesc::serialize ( int *  pSize = 0) const
virtual

Obtain a copy of the current fom in serialized form.

virtual void MAKLogger::DtBaseFomDesc::setFilterAllInteractionClasses ( )
virtual

Filter all interactions.

virtual void MAKLogger::DtBaseFomDesc::setFilterAllObjectClasses ( )
virtual

Filter all object.

virtual void MAKLogger::DtBaseFomDesc::setFilterByClass ( const DtSubscriptionMap map)
virtual

Set the current "Filter-By-Class" Map.

virtual void MAKLogger::DtBaseFomDesc::setFilterNoInteractionClasses ( )
virtual

Filter no interactions.

virtual void MAKLogger::DtBaseFomDesc::setFilterNoObjectClasses ( )
virtual

Filter no objects.

virtual int MAKLogger::DtBaseFomDesc::setFromSerialForm ( const void *  p)
virtual

Initialize by reading FOM from a "serialized-form" buffer.

virtual void MAKLogger::DtBaseFomDesc::setObjectClassHeartbeatTime ( const DtString className,
double  time,
bool  includeSubclasses = false 
)
virtual

Set the heartbeat period for the specified object class.

virtual void MAKLogger::DtBaseFomDesc::setObjectClassTimeoutTime ( const DtString className,
double  time,
bool  includeSubclasses = false 
)
virtual

Set the timeout period for the specified object class.

int MAKLogger::DtBaseFomDesc::unserialize ( const char *  bfr)
protected

Deserialize from buffer.

virtual int MAKLogger::DtBaseFomDesc::writeToFile ( FILE *  fp) const
virtual

Write contents to a logger file.

virtual int MAKLogger::DtBaseFomDesc::writeToFile64 ( int  fd) const
virtual

Member Data Documentation

std::map<DtString, DtLgrSimDriver::HeartbeatTimeRecord> MAKLogger::DtBaseFomDesc::myHeartbeatTimes
protected
std::vector<DtBaseInterClassDesc*> MAKLogger::DtBaseFomDesc::myInteractionClasses
protected

Referenced by interactionClassCount().

InteractionMap MAKLogger::DtBaseFomDesc::myInteractionLookupMap
protected
std::vector<DtBaseObjClassDesc*> MAKLogger::DtBaseFomDesc::myObjectClasses
protected

Referenced by objectClassCount().

ObjectMap MAKLogger::DtBaseFomDesc::myObjectLookupMap
protected
std::map<DtString, DtLgrSimDriver::HeartbeatTimeRecord> MAKLogger::DtBaseFomDesc::myTimeoutTimes
protected
int MAKLogger::DtBaseFomDesc::theHashSize
staticprotected

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

Document ID: Generated on Wed Jun 5 18:45:18 EDT 2019 from SVN revision 198968
Copyright © 2019 VT MAK. All Rights Reserved (www.mak.com)