VR-Exchange 2.9 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtTimeManagementBrokerInitializer Class Reference

Parses the MTL file, and reads command line input to produce a set of parameters useful for the broker. More...

Inheritance diagram for DtTimeManagementBrokerInitializer:
Inheritance graph
[legend]

Public Member Functions

 DtTimeManagementBrokerInitializer (int argc=0, char **argv=0, const char *versionString="1.0")
 CTOR. More...
 
virtual ~DtTimeManagementBrokerInitializer ()
 DTOR. More...
 
DtTimeManagementBrokerInitializeroperator= (const DtTimeManagementBrokerInitializer &other)
 Assignment Operator. More...
 
virtual void setLookahead (double)
 Set the broker's lookahead. More...
 
virtual double lookahead () const
 Get the broker's lookahead. More...
 
- Public Member Functions inherited from MAKVrExchange::DtRprBroker::DtRprBrokerInitializer
 DtRprBrokerInitializer (int argc=0, char **argv=0, const char *versionString="1.0")
 CTOR. More...
 
 DtRprBrokerInitializer (const DtRprBrokerInitializer &other)
 Copy CTOR. More...
 
virtual ~DtRprBrokerInitializer ()
 DTOR. More...
 
DtRprBrokerInitializeroperator= (const DtRprBrokerInitializer &other)
 Assignment Operator. More...
 
virtual DtRprBrokerInitializerclone () const
 Clone method. More...
 
virtual DtRprDiscoverableCriteriadiscoveryCriteria ()
 
virtual void setExecName (const DtString &)
 Set the broker's execution name. More...
 
virtual DtString execName () const
 Get the broker's execution name. More...
 
virtual void setFedFileName (const DtString &)
 Set the broker's FED File name. More...
 
virtual DtString fedFileName () const
 Get the broker's FED File name. More...
 
virtual void setFederateType (const DtString &)
 Set the broker's federate type. More...
 
virtual DtString federateType () const
 Get the broker's federate type. More...
 
virtual void setUseCustomFom (bool)
 Set whether the broker uses a custom FOM or not. More...
 
virtual bool useCustomFom () const
 Get whether the broker uses a custom FOM or not. More...
 
virtual void setRprFomVersion (double)
 Set the RPR FOM version the broker should use. More...
 
virtual double rprFomVersion () const
 Get the RPR FOM version the broker should use. More...
 
virtual void setRprFomRevision (int)
 Set the RPR FOM version's revision the broker should use. More...
 
virtual int rprFomRevision () const
 Get the RPR FOM version's revision the broker should use. More...
 
virtual void setFomMapperLibName (const DtString &)
 Set the Custom FOM Mapper's library name. More...
 
virtual DtString fomMapperLibName () const
 Get the Custom FOM Mapper's library name. More...
 
virtual void setFomMapperInitData (const DtString &)
 Set the Custom FOM Mapper's initialization data. More...
 
virtual DtString fomMapperInitData () const
 Get the Custom FOM Mapper's initialization data. More...
 
virtual void setFomMapper (DtFomMapper *)
 Set the FOM Mapper to use. More...
 
virtual const DtFomMapper * fomMapper () const
 Get the Fom Mapper used. More...
 
virtual void setUseHlaAdvisories (bool)
 Set whether the broker uses HLA advisories. More...
 
virtual bool useHlaAdvisories () const
 Get whether the broker uses HLA advisories. More...
 
virtual void setFillOutgoingEntityIds (bool)
 Set whether the broker should fill outgoing entity IDs. More...
 
virtual bool fillOutgoingEntityIds () const
 Get whether the broker should fill outgoing entity IDs. More...
 
virtual void setUsePersistentEntityIds (bool)
 Set whether the broker should use persistent entity IDs. More...
 
virtual bool usePersistentEntityIds () const
 Get whether the broker should use persistent entity IDs. More...
 
virtual void setOutgoingSiteId (int)
 Set the outgoing site ID the broker should use. More...
 
virtual int outgoingSiteId () const
 Get the outgoing site ID the broker should use. More...
 
virtual void setOutgoingHostId (int)
 Set the outgoing host ID the broker should use. More...
 
virtual int outgoingHostId () const
 Get the outgoing host ID the broker should use. More...
 
virtual void setPopulateMissingStreamTags (bool)
 Set whether to populate stream tags using entity IDs when missing. More...
 
virtual bool populateMissingStreamTags () const
 Get whether to populate stream tags using entity IDs when missing. More...
 
virtual void setUseHlaObjectIdForMarkingText (bool)
 Set whether the broker should use HLA object IDs as marking text. More...
 
virtual bool useHlaObjectIdForMarkingText () const
 Get whether the broker should use HLA object IDs as marking text. More...
 
virtual void setUseMarkingTextForHlaObjectId (bool)
 Set whether the broker should use marking text as HLA object IDs. More...
 
virtual bool useMarkingTextForHlaObjectId () const
 Get whether the broker should use marking text as HLA object IDs. More...
 
virtual void setUseAbsoluteTimeStamping (bool)
 Set whether the broker should use absolute time stamping. More...
 
virtual bool useAbsoluteTimeStamping () const
 Get whether the broker should use absolute time stamping. More...
 
virtual void setUsePerfCounter (bool)
 Set whether the broker should use the performance counter. More...
 
virtual bool usePerfCounter () const
 Get whether the broker should use the performance counter. More...
 
virtual void setLocationThreshold (double)
 Set the threshold for location changes to use when sending updates. More...
 
virtual double locationThreshold () const
 Get the threshold for location changes to use when sending updates. More...
 
virtual void setRotationThreshold (double)
 Set the threshold for rotation changes to use when sending updates. More...
 
virtual double rotationThreshold () const
 Get the threshold for rotation changes to use when sending updates. More...
 
virtual void setDisableArticulatedParts (bool)
 Set whether articulated parts translation is disabled. More...
 
virtual bool disableArticulatedParts () const
 Get whether articulated parts translation is disabled. More...
 
virtual void setTranslateFom (bool)
 Set whether the FOM should be translated. More...
 
virtual bool translateFom () const
 Get whether the FOM should be translated. More...
 
virtual void setGenericHlaObjectsToTranslate (const std::vector< DtString > &)
 Set the set of generic HLA objects to translate. More...
 
virtual void addGenericHlaObjectsToTranslate (const DtString &addr)
 Add a single HLA object to the set of objects to translate. More...
 
virtual const std::vector
< DtString > & 
genericHlaObjectsToTranslate () const
 Get the set of generic HLA objects to translate. More...
 
virtual void setGenericHlaInteractionsToTranslate (const std::vector< DtString > &)
 Set the set of generic HLA interactions to translate. More...
 
virtual void addGenericHlaInteractionsToTranslate (const DtString &addr)
 Add a single HLA interaction to the set of interactions to translate. More...
 
virtual const std::vector
< DtString > & 
genericHlaInteractionsToTranslate () const
 Get the set of generic HLA interactions to translate. More...
 
virtual void setProcessTimeouts (bool)
 Set whether to process timeouts for inactive objects. More...
 
virtual bool processTimeouts () const
 Get whether to process timeouts for inactive objects. More...
 
virtual void setTimeoutInterval (DtTime)
 Set the time to wait before timing out inactive objects. More...
 
virtual DtTime timeoutInterval () const
 Get the time to wait before timing out inactive objects. More...
 
virtual void setDiscoveryTimeoutThreshold (int threshold)
 Set the message threshold that disables timeout processing during discovery. More...
 
virtual int discoveryTimeoutThreshold () const
 Get the message threshold that disables timeout processing during discovery. More...
 
virtual void setDiscoveryTimeoutDuration (DtTime duration)
 Set the message threshold that disables timeout processing during discovery. More...
 
virtual DtTime discoveryTimeoutDuration () const
 Get the message threshold that disables timeout processing during discovery. More...
 
virtual void setHeartbeat (int)
 Set the broker's heartbeat interval. More...
 
virtual int heartbeat () const
 Get the broker's heartbeat interval. More...
 
virtual void setHlaMinTickTime (DtTime)
 Set the broker's min tick time. More...
 
virtual DtTime hlaMinTickTime () const
 Get the broker's min tick time. More...
 
virtual void setHlaMaxTickTime (DtTime)
 Set the broker's max tick time. More...
 
virtual DtTime hlaMaxTickTime () const
 Get the broker's max tick time. More...
 
- Public Member Functions inherited from MAKVrExchange::DtBrokerInitializer
 DtBrokerInitializer (int argc, char **argv, const char *version)
 Takes the command line arguments and the version of this broker in the form of a const char*. More...
 
 DtBrokerInitializer (const DtBrokerInitializer &other)
 Copy CTOR. More...
 
virtual ~DtBrokerInitializer ()
 Destructor. More...
 
DtBrokerInitializeroperator= (const DtBrokerInitializer &other)
 Assignment Operator. More...
 
virtual void parseCmdLine ()
 Parse the command line. More...
 
virtual void loadFile ()
 Load a configuration file. More...
 
virtual void loadFile (const DtString &fileName)
 
virtual bool saveFile ()
 Save a configuration file. More...
 
virtual bool saveFile (const DtString &fileName)
 
virtual DtString brokerName () const
 The name of this broker. More...
 
virtual int notifyLevel () const
 The notify level of this broker. More...
 
virtual void setNotifyLevel (int nl)
 
virtual DtString logFileName () const
 Returns the name of the log file to use. More...
 
virtual void setLogFileName (const DtString &lfn)
 
virtual bool isLogTimestampingEnabled () const
 Returns whether log file timestamps are enabled. More...
 
virtual void setLogTimestampingEnabled (bool timestamp)
 
virtual int logRollingInterval () const
 Returns the length of the interval at which log files are rolled. More...
 
virtual void setLogRollingInterval (int intervalInSeconds)
 
virtual DtTime lockFailureTimeout () const
 Returns the length of the time to wait for a successful shared memory lock. More...
 
virtual void setLockFailureTimeout (DtTime timeInSeconds)
 
virtual DtString pluginDirectory () const
 Returns the name of the plugin directory to use. More...
 
virtual void setPluginDirectory (const DtString &lfn)
 
virtual bool loadVrfPlugins () const
 Whether to load the VR-Forces Plugins. More...
 
virtual void setloadVrfPlugins (bool val)
 
virtual DtString vrfVersion () const
 VR-Forces version number (used in conjuction with plugin directory to load correct version). More...
 
virtual void setVrfVersion (const DtString &version)
 
virtual int maxControlMessages () const
 Returns the maximum number of control messages to read per tic. More...
 
virtual void setMaxControlMessages (int mcm)
 
virtual int maxInteractionMessages () const
 Returns the maximum number of Interaction messages to read per tick. More...
 
virtual void setMaxInteractionMessages (int mim)
 
virtual int maxObjectMessages () const
 Returns the maximum number of object messages to read per tick. More...
 
virtual void setMaxObjectMessages (int mom)
 
virtual int pollingInterval () const
 Returns the interval, in ms, between each call to drainInput() on the exercise connection. More...
 
virtual void setPollingInterval (int pi)
 
virtual DtTime locationFilteringInterval () const
 Returns the location filtering interval (in seconds). More...
 
virtual void setLocationFilteringInterval (DtTime t)
 
virtual DtTime statisticsReportingInterval () const
 Returns the statistics reporting interval (in seconds). More...
 
virtual void setStatisticsReportingInterval (DtTime si)
 
virtual bool printStatistics () const
 Returns whether statistics are printed to the log file. More...
 
virtual void setPrintStatistics (bool val)
 
virtual int tcpPort () const
 TCP port to use to maintain connectivity with the Data Exchange. More...
 
virtual void setTcpPort (int port)
 
virtual bool dumpEnvironment () const
 The broker can be configured to dump its known environment at startup. More...
 
virtual void setDumpEnvironment (bool shouldDumpEnv)
 
virtual DtString controlQueueName () const
 Returns the queue names for each type of queue. More...
 
virtual DtString interactionQueueName () const
 
virtual DtString objectQueueName () const
 
virtual bool oneToOneMapping () const
 Broker should generate a one to one mapping for translations. More...
 
virtual void setOneToOneMapping (bool val)
 
virtual const std::vector
< DtString > & 
debuggedTranslators () const
 Returns a list of translators who's debugging is enabled. More...
 
virtual void addDebuggedTranslator (const DtString &)
 
virtual void removeDebuggedTranslator (const DtString &)
 
virtual void setDebuggedTranslators (const std::set< DtString > &debuggedSet)
 
virtual const std::vector
< DtString > & 
disablePublishTranslatorSet () const
 Returns a list of translators who are disabled for writing (publishing). More...
 
virtual void addDisablePublishTranslator (const DtString &)
 
virtual void removeDisablePublishTranslator (const DtString &)
 
virtual void setDisablePublishTranslators (const std::set< DtString > &disabledSet)
 
virtual const std::vector
< DtString > & 
disableReflectTranslatorSet () const
 Returns a list of translators who are disabled for reading (reflecting). More...
 
virtual void addDisableReflectTranslator (const DtString &)
 
virtual void removeDisableReflectTranslator (const DtString &)
 
virtual void setDisableReflectTranslators (const std::set< DtString > &disableSet)
 
bool useGui () const
 Returns true if the broker can use a GUI. More...
 
bool showConnectionInfoDialog () const
 Returns true if the broker is given the argument to show the connection info dialog on startup. More...
 
int & argc ()
 The argument count as passed in the CTOR. More...
 
char ** argv ()
 The argument list as passed in the CTOR. More...
 
virtual void addObjectFilter (const DtObjectFilter &filter)
 
virtual void removeObjectFilter (const DtObjectFilter &filter)
 
virtual void setNameFilters (const std::vector< DtString > &filters)
 
virtual const std::vector
< DtString > & 
nameFilters () const
 
virtual void setTypeFilters (const std::vector< DtString > &filters)
 
virtual const std::vector
< DtString > & 
typeFilters () const
 
virtual void setMarkingFilters (const std::vector< DtString > &filters)
 
virtual const std::vector
< DtString > & 
markingFilters () const
 
virtual void setGeoLocationFilters (const std::vector< DtGeoLocationFilter > &filters)
 
virtual const std::vector
< DtGeoLocationFilter > & 
geoLocationFilters () const
 
virtual void setDarkModeEnabled (int val)
 
virtual int darkModeEnabled ()
 
virtual DtString fileName () const
 Returns the name of the file that this initializer refers to. More...
 
virtual DtString qtTranslatorLocale ()
 Returns the string of the translatorLocale passed in on the command line. More...
 

Protected Attributes

DtConfigVariable< double > myCmdLineLookahead
 Command line setting for the lookahead. More...
 
- Protected Attributes inherited from MAKVrExchange::DtRprBroker::DtRprBrokerInitializer
DtVariableGroup myDiscoverableCriteriaGroup
 
DtRprDiscoverableCriteriamyDiscoverableCriteria
 Helper class that manages discoverable criteria. More...
 
DtConfigVariable< DtStringmyCmdLineExecName
 
DtConfigVariable< DtStringmyCmdLineFedFileName
 
DtConfigVariable< DtStringmyCmdLineFederateType
 
DtConfigVariable< bool > myCmdLineUseCustomFom
 
DtConfigVariable< double > myCmdLineRprFomVersion
 
DtConfigVariable< int > myCmdLineRprFomRevision
 
DtConfigVariable< DtStringmyCmdLineFomMapperLibName
 
DtConfigVariable< DtStringmyCmdLineFomMapperInitData
 
DtFomMapper * myFomMapperPointer
 
DtConfigVariable< bool > myUseHlaAdvisories
 
DtConfigVariable< bool > myFillOutgoingEntityIds
 
DtConfigVariable< bool > myUsePersistentEntityIds
 
DtConfigVariable< int > myOutgoingSiteId
 
DtConfigVariable< int > myOutgoingHostId
 
DtConfigVariable< bool > myPopulateMissingStreamTags
 
DtConfigVariable< bool > myUseHlaObjectIdForMarkingText
 
DtConfigVariable< bool > myUseMarkingTextForHlaObjectId
 
DtConfigVariable< bool > myUseAbsoluteTimeStamping
 
DtConfigVariable< bool > myUsePerfCounter
 
DtConfigVariable< double > myLocationThreshold
 
DtConfigVariable< double > myRotationThreshold
 
DtConfigVariable< bool > myDisableArticulatedParts
 
DtConfigVariable< bool > myUseGenericTranslatorsForWholeFom
 
DtMultiConfigVariable< DtStringmyGenericHlaObjectsToTranslate
 
DtMultiConfigVariable< DtStringmyGenericHlaInteractionsToTranslate
 
DtConfigVariable< bool > myProcessTimeouts
 
DtConfigVariable< DtTime > myTimeoutInterval
 
DtConfigVariable< DtTime > myDiscoveryTimeoutDuration
 
DtConfigVariable< int > myDiscoveryTimeoutThreshold
 
DtConfigVariable< int > myHeartbeat
 
DtConfigVariable< DtTime > myHlaMinTickTime
 
DtConfigVariable< DtTime > myHlaMaxTickTime
 
- Protected Attributes inherited from MAKVrExchange::DtBrokerInitializer
int myArgc
 
char ** myArgv
 
DtString myProgramName
 
DtString myVersionString
 
DtApplicationSettings mySettings
 
DtConfigVariable< bool > myShowInfoDialogFlag
 
DtConfigVariable< DtStringmyMtlFileName
 
DtConfigVariable< DtStringmyCmdLineBrokerName
 
DtConfigVariable< int > myCmdLineTcpPort
 
DtConfigVariable< int > myCmdLineNotifyLevel
 
DtConfigVariable< bool > myCmdLineDumpEnvFlag
 
DtConfigVariable< bool > myUseGuiFlag
 
DtConfigVariable< DtStringmyLogFileName
 
DtConfigVariable< bool > myLogTimestampingEnabled
 
DtConfigVariable< int > myLogRollingInterval
 
DtConfigVariable< DtTime > myLockFailureTimeout
 
DtConfigVariable< DtStringmyPluginDirectory
 
DtConfigVariable< bool > myloadVrfPluginsFlag
 
DtConfigVariable< DtStringmyVrfVersion
 
DtConfigVariable< DtStringmyControlQueueName
 
DtConfigVariable< DtStringmyInteractionQueueName
 
DtConfigVariable< DtStringmyObjectQueueName
 
DtConfigVariable< bool > myOneToOneTranslation
 
DtConfigVariable< int > myMaxControlMessages
 
DtConfigVariable< int > myMaxInterMessages
 
DtConfigVariable< int > myMaxObjectMessages
 
DtConfigVariable< int > myPollingInterval
 
DtConfigVariable< DtTime > myLocationFilteringInterval
 
DtConfigVariable< DtTime > myStatisticsReportingInterval
 
DtConfigVariable< bool > myPrintStatisticsFlag
 
DtMultiConfigVariable< DtStringmyDebuggedTranslators
 
DtMultiConfigVariable< DtStringmyDisablePublishTranslators
 
DtMultiConfigVariable< DtStringmyDisableReflectTranslators
 
DtConfigVariable< DtStringmyQtTranslatorLocale
 
DtConfigVariable< int > myDarkModeEnabled
 
DtVariableGroup myObjectFiltersGroup
 
DtMultiConfigVariable< DtStringmyObjectNameFilters
 
DtMultiConfigVariable< DtStringmyObjectTypeFilters
 
DtMultiConfigVariable< DtStringmyObjectMarkingFilters
 
DtMultiConfigVariable
< DtGeoLocationFilter
myObjectGeoLocationFilters
 

Private Member Functions

 DtTimeManagementBrokerInitializer (const DtTimeManagementBrokerInitializer &other)
 Not implemented. More...
 

Detailed Description

Parses the MTL file, and reads command line input to produce a set of parameters useful for the broker.

Extends the base broker initializer to add a new parameter to allow lookahead configuration to the time management translator.

Constructor & Destructor Documentation

DtTimeManagementBrokerInitializer::DtTimeManagementBrokerInitializer ( int  argc = 0,
char **  argv = 0,
const char *  versionString = "1.0" 
)

CTOR.

virtual DtTimeManagementBrokerInitializer::~DtTimeManagementBrokerInitializer ( )
virtual

DTOR.

DtTimeManagementBrokerInitializer::DtTimeManagementBrokerInitializer ( const DtTimeManagementBrokerInitializer other)
private

Not implemented.

Member Function Documentation

virtual double DtTimeManagementBrokerInitializer::lookahead ( ) const
virtual

Get the broker's lookahead.

DtTimeManagementBrokerInitializer& DtTimeManagementBrokerInitializer::operator= ( const DtTimeManagementBrokerInitializer other)

Assignment Operator.

virtual void DtTimeManagementBrokerInitializer::setLookahead ( double  )
virtual

Set the broker's lookahead.

Member Data Documentation

DtConfigVariable<double> DtTimeManagementBrokerInitializer::myCmdLineLookahead
protected

Command line setting for the lookahead.


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

Document ID: Generated on Tue Jun 25 16:45:35 EDT 2024 from SVN revision 267383
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)