The lgrSim library provides the classes for recording a specific simulation protocol. More...

Classes
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::DtDisDescriptor
	Instances of DtDisDescriptor provide mappings between Pdu descriptors and PduKind enumerators in DIS. More...
class	MAKLogger::DtDisLogger
	DtDISLogger is a DIS interface for creating a logger. More...
class	MAKLogger::DtConstLgrDisMessage
	DIS message. More...
class	MAKLogger::DtLgrDisMessage
	DIS message. More...
class	MAKLogger::DtDisProtocolRegistration
	DIS protocol registration class. 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::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::DtLgrDisAggragatePublisher
	DIS Aggragate publisher. More...
class	MAKLogger::DtLgrArtPart
	Instances of "DtLgrArtPart" are used by DtLgrArtPartList to handle individual articulated parts (i.e. More...
class	MAKLogger::DtLgrArtPartList
	Instances of DtLgrArtPartList are used to manage articulated parts. More...
class	MAKLogger::DtLgrDisDataViewSet
	DIS specific Data set allows converting PDUS into Update/Interactions. More...
class	MAKLogger::DtLgrDisEntityPublisher
	DIS Entity Publisher. More...
class	MAKLogger::DtLgrDisEntityTracker
	Indexes packets in a file. More...
class	MAKLogger::DtLgrDisEntityTypeFilter
	Entity type filter. More...
class	MAKLogger::DtLgrDisEntityTypeManager
	Managers known DIS entity types. More...
class	MAKLogger::DtLgrDisEnvironmentalProcessPublisher
	DIS Environmental Process Publisher. More...
class	MAKLogger::DtLgrDis5_4Format
	The current Logger DIS format. More...
class	MAKLogger::DtLgrDisFileFormats
	Supported DIS File Formats. More...
class	MAKLogger::DtLgrDisGriddedDataPublisher
	Dis Gridded Data Publisher. More...
class	MAKLogger::DtLgrDisLegacyEntityTracker
	Reverts tracker encoding to legacy format 5.3 or before. More...
class	MAKLogger::DtLgrLegacyDisUncheckpointedFormat
	DIS specific file format which does not support checkpoints. More...
class	MAKLogger::DtLgrLegacyDisCheckpointedFormat
	DIS specific file format which does support checkpoints. More...
class	MAKLogger::DtLgrLegacyDis4_0Format
	DIS specific file format which does support checkpoints for Logger 4.0, 4.1. More...
class	MAKLogger::DtLgrDisMarkingFilter
	Filter that works on entity markings. More...
class	MAKLogger::DtConstLgrDisMessageFactory
	Responsible for creating and decoding DIS Messages. More...
class	MAKLogger::DtLgrDisMessageIOInfo
	Responsible for providing info about the DIS input/output. More...
class	MAKLogger::DtLgrDisMessageState
	Responsible for maintaining a DIS simulation state. More...
class	MAKLogger::DtLgrDisPlaybackFile
	A DIS playback file. More...
class	MAKLogger::DtLgrDisReceiverPublisher
	DIS Receiver Object publisher. More...
class	MAKLogger::DtLgrDisRecordFile
	A DIS Recording File. More...
class	MAKLogger::DtLgrDisSimDriver
	DIS simulation driver controls connection to DIS simulation. More...
class	MAKLogger::DtLgrDisSimInput
	DIS Simulation input class. More...
class	MAKLogger::DtLgrDisSimInterface
	Interface for controlling the connection to a DIS simulation. More...
class	MAKLogger::DtLgrDisSimulationManager
	The DIS Simulation manager manages the DIS simulation settings. More...
class	MAKLogger::DtLgrDisSimOutput
	DIS simulation output. More...
class	MAKLogger::DtDisStateObject
	A DIS state object. 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::DtLgrHlaConfigData
	Stores information about HLA logger configuration. More...
class	MAKLogger::DtLgrHlaEntityTracker
	Indexes packets in a file. 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::DtLgrPduTypeFilter
	Logger filter which. More...
class	MAKLogger::DtLgrPublisherInterface
	Responsible for defining the interface that Object publishers must have. More...
class	MAKLogger::DtPduDescriptor
	A runtime description of a DIS pdu. 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
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 &regionDesc) 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 &regionSetName)
	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 &regionSetName)
	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 &regionSet, 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 &regionSet, 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 &regionDescriptor) const
	Create a region using the given region descriptor.
virtual unsigned int	MAKLogger::DtSubscriptionListFile::getRegionSet (DtExerciseConn *exconn, const DtSubscriptionListFile::RegionDescSet &regionDescSet, DtDDMRegionSet &regionSet, 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 &regionDescriptor)
	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 > &regionmap, DtEnvValueSP regionset, DtString &regionsetname, RegionDescSet &regdescset)
	Read a region set description into the given descriptor and its name.
virtual bool	MAKLogger::DtSubscriptionListFile::readClassRegion (DtEnvironment &env, DtEnvValueSP classRegion, DtString &regionSetName, DtString *className=0)
	Read a class subscription.

Variables
DtNetU32	MAKLogger::NetUpdateRecord::classHandle
	class handle of object.
DtNetU32	MAKLogger::NetMultiTimedUpdateRecord::classHandle
	class handle of object.

Detailed Description

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.

Function Documentation

virtual bool MAKLogger::DtSubscriptionListFile::addInteractionClass	(	const DtString &	className,
		const DtString &	regionSetName
	)

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 bool MAKLogger::DtSubscriptionListFile::addObject	(	const DtString &	name,
		const DtString &	regionSetName
	)

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?

virtual DtDDMRegionSP MAKLogger::DtSubscriptionListFile::createRegion	(	DtExerciseConn *	exconn,
		const DtSubscriptionListFile::RegionDesc &	regionDescriptor
	)		const

protectedvirtual

Create a region using the given region descriptor.

Return the created region instance.

virtual bool MAKLogger::DtSubscriptionListFile::defaultInteractionClassExists ( ) const

virtual

Return bool: default interaction class exists in this list?

virtual bool MAKLogger::DtSubscriptionListFile::defaultObjectClassExists ( ) const

virtual

Return bool: default object class exists in this list?

virtual const DtString& MAKLogger::DtSubscriptionListFile::defaultRegionSetNameInteractionClassKey ( ) const

virtual

Return the interaction class key for the default region set name for interaction classes.

virtual const DtString& MAKLogger::DtSubscriptionListFile::defaultRegionSetNameObjectClassKey ( ) const

virtual

Return the object class key for the default region set name for object classes.

virtual DtSubscriptionListFile MAKLogger::DtSubscriptionListFile::diffSubscriptionList	(	const DtSubscriptionListFile &	newsublist,
		std::set< DtString > &	modifiedObjectClasses,
		std::set< DtString > &	modifiedInteractionClasses
	)

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.

virtual bool MAKLogger::DtSubscriptionListFile::getRegionDescSet	(	const DtString &	descName,
		DtSubscriptionListFile::RegionDescSet &	regionDesc
	)		const

virtual

Get the region descriptor set associated with a region set name Return bool: Region descriptor is valid? (i.e., name was found)

virtual unsigned int MAKLogger::DtSubscriptionListFile::getRegionSet	(	DtExerciseConn *	exconn,
		const DtSubscriptionListFile::RegionDescSet &	regionDescSet,
		DtDDMRegionSet &	regionSet,
		bool	cacheRegions = `true`
	)		const

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 unsigned int MAKLogger::DtSubscriptionListFile::getRegionSetForInteractionClass	(	DtExerciseConn *	exconn,
		const DtString &	className,
		DtDDMRegionSet &	regionSet,
		bool	cacheRegions = `true`
	)		const

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 unsigned int MAKLogger::DtSubscriptionListFile::getRegionSetForObject	(	DtExerciseConn *	exconn,
		const DtString &	name,
		DtDDMRegionSet &	regionSet,
		bool	cacheRegions = `true`
	)		const

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.

virtual std::set<DtString> MAKLogger::DtSubscriptionListFile::interactionClasses ( ) const

virtual

Get the interaction class list (do not consider region sets).

virtual std::set<DtString> MAKLogger::DtSubscriptionListFile::objectClasses ( ) const

virtual

Get the object class list (do not consider region sets).

virtual bool MAKLogger::DtSubscriptionListFile::readAttribute	(	DtEnvironment &	env,
		DtEnvValueSP	attribute,
		AttributeDesc &	attrributeDescriptor
	)

protectedvirtual

Read a region description into the given descriptor Return bool: read successful?

virtual bool MAKLogger::DtSubscriptionListFile::readBound	(	DtEnvironment &	env,
		DtEnvValueSP	dimension,
		const DtString &	boundName,
		unsigned long &	value
	)

protectedvirtual

Read a region bound with the given name (lowerBound or upperBound) into the given value Return bool: read successful?

virtual bool MAKLogger::DtSubscriptionListFile::readClassRegion	(	DtEnvironment &	env,
		DtEnvValueSP	classRegion,
		DtString &	regionSetName,
		DtString *	className = `0`
	)

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?

virtual bool MAKLogger::DtSubscriptionListFile::readDimension	(	DtEnvironment &	env,
		DtEnvValueSP	dimension,
		DimensionDesc &	dimimensionDescriptor
	)

protectedvirtual

Read a dimension description into the given descriptor Return bool: read successful?

virtual bool MAKLogger::DtSubscriptionListFile::readExtent	(	DtEnvironment &	env,
		DtEnvValueSP	extent,
		ExtentDesc &	extentDescriptor
	)

protectedvirtual

Read an extent description into the given descriptor Return bool: read successful?

virtual bool MAKLogger::DtSubscriptionListFile::readFromFile ( const DtString & filename )

virtual

Read the object and interaction class lists from a file.

Return values

true	If the file was read.

virtual bool MAKLogger::DtSubscriptionListFile::readRegion	(	DtEnvironment &	env,
		DtEnvValueSP	region,
		RegionDesc &	regionDescriptor
	)

protectedvirtual

Read a region description into the given descriptor Return bool: read successful?

virtual bool MAKLogger::DtSubscriptionListFile::readRegionSet	(	DtEnvironment &	env,
		const std::map< DtString, RegionDesc > &	regionmap,
		DtEnvValueSP	regionset,
		DtString &	regionsetname,
		RegionDescSet &	regdescset
	)

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 bool MAKLogger::DtSubscriptionListFile::regionDescSetExists ( const DtString & descName ) const

virtual

Return bool: Region descriptor is valid? (i.e., name was found)

virtual const DtSubscriptionListFile::RegionDescSet* MAKLogger::DtSubscriptionListFile::regionDescSetForClassName	(	const std::map< DtString, DtString > &	classNameToDescNameMap,
		const DtString &	defaultName,
		const DtString &	className,
		bool	ignoreDefaults = `false`
	)		const

protectedvirtual

Return the region descriptor set associated with the given class name from the given list; 0 if no class association exists.

virtual const DtSubscriptionListFile::RegionDescSet* MAKLogger::DtSubscriptionListFile::regionDescSetForInteractionClass	(	const DtString &	className,
		bool	ignoreDefaults = `false`
	)		const

virtual

Return the region descriptor set 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

virtual

Return the region descriptor set associated with the given object class name; 0 if no class association exists.

virtual const DtString* MAKLogger::DtSubscriptionListFile::regionDescSetNameForClassName	(	const std::map< DtString, DtString > &	classNameToDescNameMap,
		const DtString &	defaultName,
		const DtString &	className
	)		const

protectedvirtual

Return the region descriptor set name associated with the given class name from the given list; 0 if no class association exists.

virtual const DtString* MAKLogger::DtSubscriptionListFile::regionDescSetNameForInteractionClass ( const DtString & className ) const

virtual

Return the region descriptor set name associated with the given interaction class name; 0 if no class association exists.

virtual const DtString* MAKLogger::DtSubscriptionListFile::regionDescSetNameForObjectClass ( const DtString & className ) const

virtual

Return the region descriptor set name associated with the given object class name; 0 if no class association exists.

virtual void MAKLogger::DtSubscriptionListFile::removeInteractionClass ( const DtString & className )

virtual

Remove the given interaction class and any region set association (if it exists)

virtual void MAKLogger::DtSubscriptionListFile::removeObject ( const DtString & name )

virtual

Remove the given object class/instance and any region set association (if it exists)

virtual void MAKLogger::DtSubscriptionListFile::setInteractionClassList ( const std::vector< DtString > & list )

virtual

Set the interaction class list (do not consider region sets).

virtual void MAKLogger::DtSubscriptionListFile::setObjectClassList ( const std::vector< DtString > & list )

virtual

Set the object class list (do not consider region sets).

virtual void MAKLogger::DtSubscriptionListFile::setRegionDescSet	(	const DtString &	name,
		const DtSubscriptionListFile::RegionDescSet &	desc
	)

virtual

Set the region descriptor set associated with a region set name.

virtual bool MAKLogger::DtSubscriptionListFile::writeToFile ( const DtString & filename ) const

virtual

Write the object and interaction class lists to a file.

Return values

true	If the file was written.

Variable Documentation

DtNetU32 MAKLogger::NetUpdateRecord::classHandle

class handle of object.

DtNetU32 MAKLogger::NetMultiTimedUpdateRecord::classHandle

class handle of object.

Classes

Files

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation