![]() |
MAK Data Logger API Documentation for HLA
|
The lgrSim library provides the classes for recording a specific simulation protocol. More...
Classes | |
| class | MAKLogger::DtBaseAttrDesc |
| DtBaseAttrDesc is a descriptor of an HLA object attribute. More... | |
| class | MAKLogger::DtBaseFomDesc |
| class DtBaseFomDesc: More... | |
| class | MAKLogger::DtBaseHla1516Value |
| Base HLA 1516 value which includes flags and an encoded handle. More... | |
| class | MAKLogger::DtBaseHlaValue |
| Base Hla Value object. More... | |
| class | MAKLogger::DtBaseInterClassDesc |
| Represents a HLA 1516 Fom Interaction class descriptions. More... | |
| class | MAKLogger::DtBaseObjClassDesc |
| An Fom Object Class descriptions. More... | |
| class | MAKLogger::DtBaseParamDesc |
| Represents a Interaction parameter description. More... | |
| class | MAKLogger::DtHLAGenericPublisher |
| A generic HLA publisher. More... | |
| class | MAKLogger::DtHlaLogger |
| DtHlaLogger is a Hla interface for creating a logger. More... | |
| class | MAKLogger::DtLgrHlaMessageFactory |
| Decoding HLA message factory. More... | |
| class | MAKLogger::DtLgrHlaMessageState |
| HLA Specific State. More... | |
| class | MAKLogger::DtHlaProtocolRegistration |
| The HLA protocol registration class. More... | |
| class | MAKLogger::DtLgrHlaSimInput |
| HLA specific simulation input. More... | |
| class | MAKLogger::DtLgrHlaSimOutput |
| Hla specific simulation output responsible for sending messages converted from packets. More... | |
| class | MAKLogger::DtHlaTimeStampledStateRep |
| HLA Attributes stored with a timestamp per attribute. More... | |
| class | MAKLogger::DtHlaStateObject |
| A HLA state object which represents any HLA object. More... | |
| class | MAKLogger::DtHlaTimeStampedAttribute |
| An HLA attribute with a time stamp. More... | |
| class | MAKLogger::DtLgrBaseSimManager |
| Shared implementation of the Sim Manager. More... | |
| class | MAKLogger::DtLgrControlListener |
| Responsible for receiving logger control toolkit messages and decoding them into commands. More... | |
| class | MAKLogger::DtLgrDisEntityTracker |
| Indexes packets in a file. More... | |
| class | MAKLogger::DtLgrDisEntityTypeManager |
| Managers known DIS entity types. More... | |
| class | MAKLogger::DtLgrDisVRFMessageFilter |
| Filter class responsible for removing VRF Messages which are stored as data pdus. More... | |
| class | MAKLogger::DtLgrEntityTypeFilter |
| Entity type filter. More... | |
| class | MAKLogger::DtLgrHlaAggregatePublisher |
| An HLA Entity publisher. More... | |
| class | MAKLogger::DtLgrHlaAggregateStateRepository |
| An HLA Aggregate publisher. More... | |
| class | MAKLogger::DtLgrValueReference |
| Reference to an attribute value. More... | |
| class | MAKLogger::DtLgrValueMapFactory |
| LgrValueMap factory responsible for creating DtLgrHandleValueMaps. More... | |
| class | MAKLogger::DtLgrHlaCommandFactory |
| Factory for create HLA simulation commands. More... | |
| class | MAKLogger::DtLgrHlaConfigData |
| Stores information about HLA logger configuration. More... | |
| class | MAKLogger::DtLgrHlaEntityPublisher |
| An HLA Entity publisher. More... | |
| class | MAKLogger::DtLgrHlaEntityStateRepository |
| An HLA Entity publisher. More... | |
| class | MAKLogger::DtLgrHlaEntityTracker |
| Indexes packets in a file. More... | |
| class | MAKLogger::DtLgrHlaEntityTypeFilter |
| Entity type filter. More... | |
| class | MAKLogger::DtLgrHlaFormat |
| Current Hla File format. More... | |
| class | MAKLogger::DtLgrHlaFileFormats |
| HLA File format registration object. More... | |
| class | MAKLogger::DtLgrHlaFilterByClass |
| A Filter to filter packets by their HLA object or interaction class. More... | |
| class | MAKLogger::DtLgrLegacyHlaUncheckpointedFormat |
| HLA specific file format which does not support checkpoints. More... | |
| class | MAKLogger::DtLgrLegacyHlaCheckpointedFormat |
| HLA specific file format which does support checkpoints. More... | |
| class | MAKLogger::DtNetAttributeHeader |
| An attribute header which stores the handle and the length of data. More... | |
| class | MAKLogger::DtNetDDMRegionHeader |
| This is a multipurpose header used for both HLA 1.3 and HLA 1516 Region Descriptions nameSize is general for both HLA 1.3 and HLA 1516, but will hold different information In HLA 1.3, nameSize holds the length of the Routing Space Name In HLA 1516, nameSize holds the length of the RegionHandle handle regionHandleSize is the length of the regionHandle's name representation length is the total data size of this Region with all its Extents/Dimensions/data numExtents holds the number of extents this Region has regionToken is designed to hold the value of a RTI::RegionToken ( HLA 1.3 concept for Region Marshalling ) 32 bits are reserved... More... | |
| class | MAKLogger::DtNetDDMDimensionHeader |
| generic header that can store a single dimension Extents will have 1 or more dimensions More... | |
| class | MAKLogger::NetUpdateRecord |
| Net structure for an update record. More... | |
| class | MAKLogger::NetMultiTimedUpdateRecord |
| Record of a multiTimedUpdate. More... | |
| class | MAKLogger::NetTimedUpdateRecord |
| Net structure for Update Record. More... | |
| class | MAKLogger::NetRemovalRecord |
| Net structor for a removal record. More... | |
| class | MAKLogger::DtLgrHlaPlaybackFile |
| Hla Playback file. More... | |
| class | MAKLogger::DtLgrHlaRecordFile |
| AN HLA File for Recording. More... | |
| class | MAKLogger::DtLgrHlaSimDriver |
| HLA specific driver for controlling the simulation. More... | |
| class | MAKLogger::DtLgrHlaSimInterface |
| Interface for HLA simulation. More... | |
| class | MAKLogger::DtLgrHlaSimulationManager |
| The HLA simulation manager. More... | |
| class | MAKLogger::DtLgrHlaTimeProvider |
| A Time provider that supports Wall clock time and time management. More... | |
| class | MAKLogger::DtLgrHlaUnknownAttributeRepository |
| An HLA Entity publisher. More... | |
| class | MAKLogger::DtLgrHlaVRFMessageFilter |
| HLA VRF message filter. More... | |
| class | MAKLogger::DtLgrPublisherInterface |
| Responsible for defining the interface that Object publishers must have. More... | |
| class | MAKLogger::DtLgrOnlineFomDesc |
| An online fom description that has access to the RTI Ambassidor. More... | |
| class | MAKLogger::DtRemoteControlDomainInterface |
| Base class for handling commands and responses. More... | |
| class | MAKLogger::DtRemoteControlEditorInterface |
| Responsible for invoking editor commands and processing editor responses. More... | |
| class | MAKLogger::DtRemoteControlInterface |
| Primary interface to remote loggers. More... | |
| class | MAKLogger::DtRemoteControlPlaybackInterface |
| Responsible for invoking playback commands and processing playback responses. More... | |
| class | MAKLogger::DtRemoteControlRecordInterface |
| Responsible for invoking record commands and processing record responses. More... | |
| class | MAKLogger::DtRemoteControlSharedInterface |
| Responsible for invoking shared commands and processing shared responses. More... | |
| class | MAKLogger::DtRemoteControlSimulationInterface |
| Responsible for invoking simulation commands and processing simulation responses. More... | |
| class | MAKLogger::DtRemoteControlSystemInterface |
| Responsible for invoking system commands and processing system responses. More... | |
| class | MAKLogger::DtSubscriptionListFile |
| The subscription list file allow reading and writing of subscription list data to and from a file. More... | |
Files | |
| file | lgrFedAmb13.h |
| file | lgrFedAmb1516.h |
| file | lgrFedAmb1516e.h |
Functions | |
| MAKLogger::DtBaseInterClassDesc::DtBaseInterClassDesc (const DtString &className, DtBaseInterClassDesc *baseClass, DtLgrHlaHandle handle, const void *handCode, int codeSize) | |
| Main constructor. | |
| MAKLogger::DtBaseInterClassDesc::DtBaseInterClassDesc (const DtString &className, const DtString &baseClassName, DtLgrHlaHandle hand, const void *handCode, int codeSize) | |
| Incomplete constructor (from names only, with delayed initialization) | |
| MAKLogger::DtBaseObjClassDesc::DtBaseObjClassDesc (const DtString &className, DtBaseObjClassDesc *baseClass, unsigned int hand, const void *handCode, int codeSize) | |
| Main Constructor. | |
| virtual void | MAKLogger::DtLgrHlaFilterByClass::setFilterObjectClass (const DtString &className, bool filtered) |
| Set whether an object class is filtered. | |
| virtual bool | MAKLogger::DtLgrHlaFilterByClass::isObjectClassFiltered (const DtString &className) const |
| Check whether a class is filtered. | |
| virtual void | MAKLogger::DtLgrHlaFilterByClass::setFilterInteractionClass (const DtString &className, bool filtered) |
| Set whether an interaction class is filtered. | |
| virtual bool | MAKLogger::DtLgrHlaFilterByClass::isInteractionClassFiltered (const DtString &className) const |
| Check whether a class is filtered. | |
| virtual bool | MAKLogger::DtLgrHlaSimulationManager::getSubscribeRegionSetForObjectClass (const DtString &classname, DtDDMRegionSet ®ionSet) const |
| Get the subscribe region set used for the specified object class, or an empty set if none Return bool: found region set. | |
| virtual bool | MAKLogger::DtLgrHlaSimulationManager::getSubscribeRegionSetForInteractionClass (const DtString &classname, DtDDMRegionSet ®ionSet) const |
| Get the subscribe region set used for the specified interaction class, or an empty set if none Return bool: found region set. | |
| virtual bool | MAKLogger::DtSubscriptionListFile::defaultObjectClassExists () const |
| Return bool: default object class exists in this list? | |
| virtual bool | MAKLogger::DtSubscriptionListFile::defaultInteractionClassExists () const |
| Return bool: default interaction class exists in this list? | |
| virtual std::set< DtString > | MAKLogger::DtSubscriptionListFile::objectClasses () const |
| Get the object class list (do not consider region sets). | |
| virtual void | MAKLogger::DtSubscriptionListFile::setObjectClassList (const std::vector< DtString > &list) |
| Set the object class list (do not consider region sets). | |
| virtual std::set< DtString > | MAKLogger::DtSubscriptionListFile::interactionClasses () const |
| Get the interaction class list (do not consider region sets). | |
| virtual void | MAKLogger::DtSubscriptionListFile::setInteractionClassList (const std::vector< DtString > &list) |
| Set the interaction class list (do not consider region sets). | |
| virtual void | MAKLogger::DtSubscriptionListFile::setRegionDescSet (const DtString &name, const DtSubscriptionListFile::RegionDescSet &desc) |
| Set the region descriptor set associated with a region set name. | |
| virtual bool | MAKLogger::DtSubscriptionListFile::getRegionDescSet (const DtString &descName, DtSubscriptionListFile::RegionDescSet ®ionDesc) const |
| Get the region descriptor set associated with a region set name Return bool: Region descriptor is valid? (i.e., name was found) | |
| virtual bool | MAKLogger::DtSubscriptionListFile::regionDescSetExists (const DtString &descName) const |
| Return bool: Region descriptor is valid? (i.e., name was found) | |
| virtual bool | MAKLogger::DtSubscriptionListFile::addObject (const DtString &name, const DtString ®ionSetName) |
| Add an association between the given object class/instance name and region descriptor set name (replaces any prior association) The association is added only if the region descriptor set exists or the name is empty. | |
| virtual void | MAKLogger::DtSubscriptionListFile::removeObject (const DtString &name) |
| Remove the given object class/instance and any region set association (if it exists) | |
| virtual bool | MAKLogger::DtSubscriptionListFile::addInteractionClass (const DtString &className, const DtString ®ionSetName) |
| Add an association between the given interaction class name and region descriptor set name (replaces any prior association) The association is added only if the region descriptor set exists or the name is empty. | |
| virtual void | MAKLogger::DtSubscriptionListFile::removeInteractionClass (const DtString &className) |
| Remove the given interaction class and any region set association (if it exists) | |
| virtual const DtString * | MAKLogger::DtSubscriptionListFile::regionDescSetNameForObjectClass (const DtString &className) const |
| Return the region descriptor set name associated with the given object class name; 0 if no class association exists. | |
| virtual const DtString * | MAKLogger::DtSubscriptionListFile::regionDescSetNameForInteractionClass (const DtString &className) const |
| Return the region descriptor set name associated with the given interaction class name; 0 if no class association exists. | |
| virtual const DtSubscriptionListFile::RegionDescSet * | MAKLogger::DtSubscriptionListFile::regionDescSetForObjectClass (const DtString &className, bool ignoreDefaults=false) const |
| Return the region descriptor set associated with the given object class name; 0 if no class association exists. | |
| virtual const DtSubscriptionListFile::RegionDescSet * | MAKLogger::DtSubscriptionListFile::regionDescSetForInteractionClass (const DtString &className, bool ignoreDefaults=false) const |
| Return the region descriptor set associated with the given interaction class name; 0 if no class association exists. | |
| virtual unsigned int | MAKLogger::DtSubscriptionListFile::getRegionSetForObject (DtExerciseConn *exconn, const DtString &name, DtDDMRegionSet ®ionSet, bool cacheRegions=true) const |
| Using the region descriptor set associated with the given object class/instance name, get regions (or create as necessary) and put them in the supplied region set. | |
| virtual unsigned int | MAKLogger::DtSubscriptionListFile::getRegionSetForInteractionClass (DtExerciseConn *exconn, const DtString &className, DtDDMRegionSet ®ionSet, bool cacheRegions=true) const |
| Using the region descriptor set associated with the given interaction class name, get regions (or create as necessary) and put them in the supplied region set. | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readFromFile (const DtString &filename) |
| Read the object and interaction class lists from a file. | |
| virtual bool | MAKLogger::DtSubscriptionListFile::writeToFile (const DtString &filename) const |
| Write the object and interaction class lists to a file. | |
| virtual const DtString & | MAKLogger::DtSubscriptionListFile::defaultRegionSetNameObjectClassKey () const |
| Return the object class key for the default region set name for object classes. | |
| virtual const DtString & | MAKLogger::DtSubscriptionListFile::defaultRegionSetNameInteractionClassKey () const |
| Return the interaction class key for the default region set name for interaction classes. | |
| virtual DtSubscriptionListFile | MAKLogger::DtSubscriptionListFile::diffSubscriptionList (const DtSubscriptionListFile &newsublist, std::set< DtString > &modifiedObjectClasses, std::set< DtString > &modifiedInteractionClasses) |
| Return a subscription list containing only subscriptions that appear in newsublist without identical entries in this. | |
| virtual const DtString * | MAKLogger::DtSubscriptionListFile::regionDescSetNameForClassName (const std::map< DtString, DtString > &classNameToDescNameMap, const DtString &defaultName, const DtString &className) const |
| Return the region descriptor set name associated with the given class name from the given list; 0 if no class association exists. | |
| virtual const DtSubscriptionListFile::RegionDescSet * | MAKLogger::DtSubscriptionListFile::regionDescSetForClassName (const std::map< DtString, DtString > &classNameToDescNameMap, const DtString &defaultName, const DtString &className, bool ignoreDefaults=false) const |
| Return the region descriptor set associated with the given class name from the given list; 0 if no class association exists. | |
| virtual DtDDMRegionSP | MAKLogger::DtSubscriptionListFile::createRegion (DtExerciseConn *exconn, const DtSubscriptionListFile::RegionDesc ®ionDescriptor) const |
| Create a region using the given region descriptor. | |
| virtual unsigned int | MAKLogger::DtSubscriptionListFile::getRegionSet (DtExerciseConn *exconn, const DtSubscriptionListFile::RegionDescSet ®ionDescSet, DtDDMRegionSet ®ionSet, bool cacheRegions=true) const |
| Fill the given region set with regions using the given set of region descriptor. | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readRegion (DtEnvironment &env, DtEnvValueSP region, RegionDesc ®ionDescriptor) |
| Read a region description into the given descriptor Return bool: read successful? | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readAttribute (DtEnvironment &env, DtEnvValueSP attribute, AttributeDesc &attrributeDescriptor) |
| Read a region description into the given descriptor Return bool: read successful? | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readExtent (DtEnvironment &env, DtEnvValueSP extent, ExtentDesc &extentDescriptor) |
| Read an extent description into the given descriptor Return bool: read successful? | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readDimension (DtEnvironment &env, DtEnvValueSP dimension, DimensionDesc &dimimensionDescriptor) |
| Read a dimension description into the given descriptor Return bool: read successful? | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readBound (DtEnvironment &env, DtEnvValueSP dimension, const DtString &boundName, unsigned long &value) |
| Read a region bound with the given name (lowerBound or upperBound) into the given value Return bool: read successful? | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readRegionSet (DtEnvironment &env, const std::map< DtString, RegionDesc > ®ionmap, DtEnvValueSP regionset, DtString ®ionsetname, RegionDescSet ®descset) |
| Read a region set description into the given descriptor and its name. | |
| virtual bool | MAKLogger::DtSubscriptionListFile::readClassRegion (DtEnvironment &env, DtEnvValueSP classRegion, DtString ®ionSetName, DtString *className=0) |
| Read a class subscription. | |
Variables | |
| DtNetU32 | MAKLogger::NetUpdateRecord::classHandle |
| class handle of object. | |
| DtNetU32 | MAKLogger::NetMultiTimedUpdateRecord::classHandle |
| class handle of object. | |
The lgrSim library provides the classes for recording a specific simulation protocol.
lgrSim has three versions, one for each supported protocol. Each variation is linked against the corresponding VR-Link library. The lgrSim libraries also function as a lgrApp plugin.
|
virtual |
Add an association between the given interaction class name and region descriptor set name (replaces any prior association) The association is added only if the region descriptor set exists or the name is empty.
Return bool: association was added successfully?
|
virtual |
Add an association between the given object class/instance name and region descriptor set name (replaces any prior association) The association is added only if the region descriptor set exists or the name is empty.
Return bool: association was added successfully?
|
protectedvirtual |
Create a region using the given region descriptor.
Return the created region instance.
|
virtual |
Return bool: default interaction class exists in this list?
|
virtual |
Return bool: default object class exists in this list?
|
virtual |
Return the interaction class key for the default region set name for interaction classes.
|
virtual |
Return the object class key for the default region set name for object classes.
|
virtual |
Return a subscription list containing only subscriptions that appear in newsublist without identical entries in this.
modifiedObjectClasses and modifiedInteractionClasses are filled with the names of classes that are either different in both or present in this and not in newsublist.
| MAKLogger::DtBaseInterClassDesc::DtBaseInterClassDesc | ( | const DtString & | className, |
| DtBaseInterClassDesc * | baseClass, | ||
| DtLgrHlaHandle | handle, | ||
| const void * | handCode, | ||
| int | codeSize | ||
| ) |
Main constructor.
| MAKLogger::DtBaseInterClassDesc::DtBaseInterClassDesc | ( | const DtString & | className, |
| const DtString & | baseClassName, | ||
| DtLgrHlaHandle | hand, | ||
| const void * | handCode, | ||
| int | codeSize | ||
| ) |
Incomplete constructor (from names only, with delayed initialization)
| MAKLogger::DtBaseObjClassDesc::DtBaseObjClassDesc | ( | const DtString & | className, |
| DtBaseObjClassDesc * | baseClass, | ||
| unsigned int | hand, | ||
| const void * | handCode, | ||
| int | codeSize | ||
| ) |
Main Constructor.
|
virtual |
Get the region descriptor set associated with a region set name Return bool: Region descriptor is valid? (i.e., name was found)
|
protectedvirtual |
Fill the given region set with regions using the given set of region descriptor.
Regions are cached and reused when specified. Return the size of the region set
|
virtual |
Using the region descriptor set associated with the given interaction class name, get regions (or create as necessary) and put them in the supplied region set.
Return the resulting region set size.
|
virtual |
Using the region descriptor set associated with the given object class/instance name, get regions (or create as necessary) and put them in the supplied region set.
Return the resulting region set size.
|
protectedvirtual |
Get the subscribe region set used for the specified interaction class, or an empty set if none Return bool: found region set.
|
protectedvirtual |
Get the subscribe region set used for the specified object class, or an empty set if none Return bool: found region set.
|
virtual |
Get the interaction class list (do not consider region sets).
|
virtual |
Check whether a class is filtered.
|
virtual |
Check whether a class is filtered.
|
virtual |
Get the object class list (do not consider region sets).
|
protectedvirtual |
Read a region description into the given descriptor Return bool: read successful?
|
protectedvirtual |
Read a region bound with the given name (lowerBound or upperBound) into the given value Return bool: read successful?
|
protectedvirtual |
Read a class subscription.
Get the region (if it specified in the file). The class may be known already (getting the default region); in which case, the class pointer is null and it is not read. Return bool: read successful?
|
protectedvirtual |
Read a dimension description into the given descriptor Return bool: read successful?
|
protectedvirtual |
Read an extent description into the given descriptor Return bool: read successful?
|
virtual |
Read the object and interaction class lists from a file.
| true | If the file was read. |
|
protectedvirtual |
Read a region description into the given descriptor Return bool: read successful?
|
protectedvirtual |
Read a region set description into the given descriptor and its name.
The regions must be in the given map. Return bool: read successful?
|
virtual |
Return bool: Region descriptor is valid? (i.e., name was found)
|
protectedvirtual |
Return the region descriptor set associated with the given class name from the given list; 0 if no class association exists.
|
virtual |
Return the region descriptor set associated with the given interaction class name; 0 if no class association exists.
|
virtual |
Return the region descriptor set associated with the given object class name; 0 if no class association exists.
|
protectedvirtual |
Return the region descriptor set name associated with the given class name from the given list; 0 if no class association exists.
|
virtual |
Return the region descriptor set name associated with the given interaction class name; 0 if no class association exists.
|
virtual |
Return the region descriptor set name associated with the given object class name; 0 if no class association exists.
|
virtual |
Remove the given interaction class and any region set association (if it exists)
|
virtual |
Remove the given object class/instance and any region set association (if it exists)
|
virtual |
Set whether an interaction class is filtered.
|
virtual |
Set whether an object class is filtered.
|
virtual |
Set the interaction class list (do not consider region sets).
|
virtual |
Set the object class list (do not consider region sets).
|
virtual |
Set the region descriptor set associated with a region set name.
|
virtual |
Write the object and interaction class lists to a file.
| true | If the file was written. |
| DtNetU32 MAKLogger::NetUpdateRecord::classHandle |
class handle of object.
| DtNetU32 MAKLogger::NetMultiTimedUpdateRecord::classHandle |
class handle of object.