 |
VR-Exchange 2.2 API Documentation
|
|
VR-Exchange 2.2 API Documentation
|
Parses the MTL file, and reads command line input to produce a set of parameters useful for the broker. More...
Public Member Functions | |
| DtTimeManagementBrokerInitializer (int argc=0, char **argv=0, const char *versionString="1.0") | |
| CTOR. | |
| virtual | ~DtTimeManagementBrokerInitializer () |
| DTOR. | |
| DtTimeManagementBrokerInitializer & | operator= (const DtTimeManagementBrokerInitializer &other) |
| Assignment Operator. | |
| virtual void | setLookahead (double) |
| Set the broker's lookahead. | |
| virtual double | lookahead () const |
| Get the broker's lookahead. | |
 Public Member Functions inherited from MAKVrExchange::DtRprBroker::DtRprBrokerInitializer | |
| DtRprBrokerInitializer (int argc=0, char **argv=0, const char *versionString="1.0") | |
| CTOR. | |
| virtual | ~DtRprBrokerInitializer () |
| DTOR. | |
| DtRprBrokerInitializer & | operator= (const DtRprBrokerInitializer &other) |
| Assignment Operator. | |
| virtual DtRprDiscoverableCriteria * | discoveryCriteria () |
| virtual void | setExecName (const DtString &) |
| Set the broker's execution name. | |
| virtual DtString | execName () const |
| Get the broker's execution name. | |
| virtual void | setFedFileName (const DtString &) |
| Set the broker's FED File name. | |
| virtual DtString | fedFileName () const |
| Get the broker's FED File name. | |
| virtual void | setFederateType (const DtString &) |
| Set the broker's federate type. | |
| virtual DtString | federateType () const |
| Get the broker's federate type. | |
| virtual void | setUseCustomFom (bool) |
| Set whether the broker uses a custom FOM or not. | |
| virtual bool | useCustomFom () const |
| Get whether the broker uses a custom FOM or not. | |
| virtual void | setRprFomVersion (double) |
| Set the RPR FOM version the broker should use. | |
| virtual double | rprFomVersion () const |
| Get the RPR FOM version the broker should use. | |
| virtual void | setRprFomRevision (int) |
| Set the RPR FOM version's revision the broker should use. | |
| virtual int | rprFomRevision () const |
| Get the RPR FOM version's revision the broker should use. | |
| virtual void | setFomMapperLibName (const DtString &) |
| Set the Custom FOM Mapper's library name. | |
| virtual DtString | fomMapperLibName () const |
| Get the Custom FOM Mapper's library name. | |
| virtual void | setFomMapperInitData (const DtString &) |
| Set the Custom FOM Mapper's initialization data. | |
| virtual DtString | fomMapperInitData () const |
| Get the Custom FOM Mapper's initialization data. | |
| virtual void | setFomMapper (DtFomMapper *) |
| Set the FOM Mapper to use. | |
| virtual const DtFomMapper * | fomMapper () const |
| Get the Fom Mapper used. | |
| virtual void | setUseHlaAdvisories (bool) |
| Set whether the broker uses HLA advisories. | |
| virtual bool | useHlaAdvisories () const |
| Get whether the broker uses HLA advisories. | |
| virtual void | setFillOutgoingEntityIds (bool) |
| Set whether the broker should fill outgoing entity IDs. | |
| virtual bool | fillOutgoingEntityIds () const |
| Get whether the broker should fill outgoing entity IDs. | |
| virtual void | setUsePersistentEntityIds (bool) |
| Set whether the broker should use persistent entity IDs. | |
| virtual bool | usePersistentEntityIds () const |
| Get whether the broker should use persistent entity IDs. | |
| virtual void | setOutgoingSiteId (int) |
| Set the outgoing site ID the broker should use. | |
| virtual int | outgoingSiteId () const |
| Get the outgoing site ID the broker should use. | |
| virtual void | setOutgoingHostId (int) |
| Set the outgoing host ID the broker should use. | |
| virtual int | outgoingHostId () const |
| Get the outgoing host ID the broker should use. | |
| virtual void | setUseHlaObjectIdForMarkingText (bool) |
| Set whether the broker should use HLA object IDs as marking text. | |
| virtual bool | useHlaObjectIdForMarkingText () const |
| Get whether the broker should use HLA object IDs as marking text. | |
| virtual void | setUseMarkingTextForHlaObjectId (bool) |
| Set whether the broker should use marking text as HLA object IDs. | |
| virtual bool | useMarkingTextForHlaObjectId () const |
| Get whether the broker should use marking text as HLA object IDs. | |
| virtual void | setUseAbsoluteTimeStamping (bool) |
| Set whether the broker should use absolute time stamping. | |
| virtual bool | useAbsoluteTimeStamping () const |
| Get whether the broker should use absolute time stamping. | |
| virtual void | setDisableArticulatedParts (bool) |
| Set whether articulated parts translation is disabled. | |
| virtual bool | disableArticulatedParts () const |
| Get whether articulated parts translation is disabled. | |
| virtual void | setTranslateFom (bool) |
| Set whether the FOM should be translated. | |
| virtual bool | translateFom () const |
| Get whether the FOM should be translated. | |
| virtual void | setGenericHlaObjectsToTranslate (const std::vector< DtString > &) |
| Set the set of generic HLA objects to translate. | |
| virtual void | addGenericHlaObjectsToTranslate (const DtString &addr) |
| Add a single HLA object to the set of objects to translate. | |
| virtual const std::vector < DtString > & | genericHlaObjectsToTranslate () const |
| Get the set of generic HLA objects to translate. | |
| virtual void | setGenericHlaInteractionsToTranslate (const std::vector< DtString > &) |
| Set the set of generic HLA interactions to translate. | |
| virtual void | addGenericHlaInteractionsToTranslate (const DtString &addr) |
| Add a single HLA interaction to the set of interactions to translate. | |
| virtual const std::vector < DtString > & | genericHlaInteractionsToTranslate () const |
| Get the set of generic HLA interactions to translate. | |
| virtual void | setHeartbeat (int) |
| Set the broker's heartbeat interval. | |
| virtual int | heartbeat () const |
| Get the broker's heartbeat interval. | |
| virtual void | setHlaMaxTickTime (DtTime) |
| Set the broker's max tick time. | |
| virtual DtTime | hlaMaxTickTime () const |
| Get the broker's max tick time. | |
| virtual void | setHlaMinTickTime (DtTime) |
| Set the broker's min tick time. | |
| virtual DtTime | hlaMinTickTime () const |
| Get the broker's min tick time. | |
| 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 *. | |
| virtual | ~DtBrokerInitializer () |
| Destructor. | |
| DtBrokerInitializer & | operator= (const DtBrokerInitializer &other) |
| Assignment Operator. | |
| virtual void | parseCmdLine () |
| Parse the command line. | |
| virtual void | loadFile () |
| Load a configuration file. | |
| virtual void | loadFile (const DtString &fileName) |
| virtual void | saveFile () |
| Save a configuration file. | |
| virtual void | saveFile (const DtString &fileName) |
| virtual DtString | brokerName () const |
| The name of this broker. | |
| virtual int | notifyLevel () const |
| The notify level of this broker. | |
| virtual void | setNotifyLevel (int nl) |
| DtString | logFileName () const |
| Returns the name of the log file to use. | |
| virtual void | setLogFileName (const DtString &lfn) |
| DtString | pluginDirectory () const |
| Returns the name of the log file to use. | |
| virtual void | setPluginDirectory (const DtString &lfn) |
| virtual int | maxControlMessages () const |
| Returns the maximum number of control messages to read per tic. | |
| virtual void | setMaxControlMessages (int mcm) |
| virtual int | maxInteractionMessages () const |
| Returns the maximum number of Interaction messages to read per tick. | |
| virtual void | setMaxInteractionMessages (int mim) |
| virtual int | maxObjectMessages () const |
| Returns the maximum number of object messages to read per tick. | |
| virtual void | setMaxObjectMessages (int mom) |
| virtual int | pollingInterval () const |
| Returns the interval, in ms, between each call to drainInput() on the exercise connection. | |
| virtual void | setPollingInterval (int pi) |
| virtual DtTime | statisticsReportingInterval () const |
| Returns the statistics reporting interval (in seconds). | |
| virtual void | setStatisticsReportingInterval (DtTime si) |
| virtual bool | printStatistics () const |
| Returns whether statistics are printed to the log file. | |
| virtual void | setPrintStatistics (bool val) |
| virtual int | tcpPort () const |
| TCP port to use to maintain connectivity with the Data Exchange. | |
| virtual void | setTcpPort (int port) |
| virtual bool | dumpEnvironment () const |
| The broker can be configured to dump its known environment at startup. | |
| virtual void | setDumpEnvironment (bool shouldDumpEnv) |
| virtual DtString | controlQueueName () const |
| Returns the queue names for each type of queue. | |
| virtual DtString | interactionQueueName () const |
| virtual DtString | objectQueueName () const |
| virtual bool | oneToOneMapping () const |
| Broker should generate a one to one mapping for translations. | |
| virtual void | setOneToOneMapping (bool val) |
| virtual const std::vector < DtString > & | debuggedTranslators () const |
| Returns a list of translators who's debugging is enabled. | |
| virtual void | addDebuggedTranslator (const DtString &) |
| virtual void | removeDebuggedTranslator (const DtString &) |
| virtual void | setDebuggedTranslators (const std::set< DtString > &debuggedSet) |
| virtual const std::vector < DtString > & | disabledTranslatorSet () const |
| Returns a list of translators who are disabled. | |
| virtual void | addDisabledTranslator (const DtString &) |
| virtual void | removeDisabledTranslator (const DtString &) |
| virtual void | setDisabledTranslators (const std::set< DtString > &disabledSet) |
| bool | useGui () const |
| Returns true if the broker can use a GUI. | |
| bool | showConnectionInfoDialog () const |
| Returns true if the broker is given the argument to show the connection info dialog on startup. | |
| int & | argc () |
| The argument count as passed in the CTOR. | |
| char ** | argv () |
| The argument list as passed in the CTOR. | |
| DtCmdLine::CmdLine & | cmdLine () |
| Returns a reference to the CMD Line Object. | |
| const std::vector < DtObjectFilter > & | objectFilters () const |
| A list of all objects set for filtering in this broker. | |
| virtual void | setObjectFilters (const std::vector< DtObjectFilter > &filters) |
| virtual void | addObjectFilter (const DtObjectFilter &filter) |
| virtual void | removeObjectFilter (const DtObjectFilter &filter) |
| DtString | fileName () const |
| Returns the name of the file that this initializer refers to. | |
Protected Attributes | |
| DtConfigVariable< double > | myCmdLineLookahead |
| Command line setting for the lookahead. | |
| Protected Attributes inherited from MAKVrExchange::DtRprBroker::DtRprBrokerInitializer | |
| DtVariableGroup | myDiscoverableCriteriaGroup |
| DtRprDiscoverableCriteria * | myDiscoverableCriteria |
| Helper class that manages discoverable criteria. | |
| DtConfigVariable< DtString > | myCmdLineExecName |
| DtConfigVariable< DtString > | myCmdLineFedFileName |
| DtConfigVariable< DtString > | myCmdLineFederateType |
| DtConfigVariable< bool > | myCmdLineUseCustomFom |
| DtConfigVariable< double > | myCmdLineRprFomVersion |
| DtConfigVariable< int > | myCmdLineRprFomRevision |
| DtConfigVariable< DtString > | myCmdLineFomMapperLibName |
| DtConfigVariable< DtString > | myCmdLineFomMapperInitData |
| DtFomMapper * | myFomMapperPointer |
| DtConfigVariable< bool > | myUseHlaAdvisories |
| DtConfigVariable< bool > | myFillOutgoingEntityIds |
| DtConfigVariable< bool > | myUsePersistentEntityIds |
| DtConfigVariable< int > | myOutgoingSiteId |
| DtConfigVariable< int > | myOutgoingHostId |
| DtConfigVariable< bool > | myUseHlaObjectIdForMarkingText |
| DtConfigVariable< bool > | myUseMarkingTextForHlaObjectId |
| DtConfigVariable< bool > | myUseAbsoluteTimeStamping |
| DtConfigVariable< bool > | myDisableArticulatedParts |
| DtConfigVariable< bool > | myUseGenericTranslatorsForWholeFom |
| DtMultiConfigVariable< DtString > | myGenericHlaObjectsToTranslate |
| DtMultiConfigVariable< DtString > | myGenericHlaInteractionsToTranslate |
| DtConfigVariable< int > | myHeartbeat |
| DtConfigVariable< DtTime > | myHlaMaxTickTime |
| DtConfigVariable< DtTime > | myHlaMinTickTime |
| Protected Attributes inherited from MAKVrExchange::DtBrokerInitializer | |
| DtConfigVariable< bool > * | myShowInfoDialogFlag |
| DtConfigVariable< DtString > * | myMtlFileName |
| DtConfigVariable< DtString > * | myCmdLineBrokerName |
| DtConfigVariable< int > * | myCmdLineTcpPort |
| DtConfigVariable< int > * | myCmdLineNotifyLevel |
| DtConfigVariable< bool > * | myCmdLineDumpEnvFlag |
| DtConfigVariable< bool > * | myUseGuiFlag |
| DtConfigVariable< DtString > * | myLogFileName |
| DtConfigVariable< DtString > * | myPluginDirectory |
| DtConfigVariable< DtString > * | myControlQueueName |
| DtConfigVariable< DtString > * | myInteractionQueueName |
| DtConfigVariable< DtString > * | myObjectQueueName |
| DtConfigVariable< bool > * | myOneToOneTranslation |
| DtConfigVariable< int > * | myMaxControlMessages |
| DtConfigVariable< int > * | myMaxInterMessages |
| DtConfigVariable< int > * | myMaxObjectMessages |
| DtConfigVariable< int > * | myPollingInterval |
| DtConfigVariable< DtTime > * | myStatisticsReportingInterval |
| DtConfigVariable< bool > * | myPrintStatisticsFlag |
| DtMultiConfigVariable< DtString > * | myDebuggedTranslators |
| DtMultiConfigVariable< DtString > * | myDisabledTranslators |
| DtMultiConfigVariable < DtObjectFilter > * | myFilterManagerConfig |
| int | myArgc |
| char ** | myArgv |
| DtString | myProgramName |
| DtString | myVersionString |
| DtApplicationSettings | mySettings |
Private Member Functions | |
| DtTimeManagementBrokerInitializer (const DtTimeManagementBrokerInitializer &other) | |
| Not implemented. | |
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.
| DtTimeManagementBrokerInitializer::DtTimeManagementBrokerInitializer | ( | int | argc = 0, |
| char ** | argv = 0, |
||
| const char * | versionString = "1.0" |
||
| ) |
CTOR.
|
virtual |
DTOR.
|
private |
Not implemented.
| DtTimeManagementBrokerInitializer& DtTimeManagementBrokerInitializer::operator= | ( | const DtTimeManagementBrokerInitializer & | other | ) |
Assignment Operator.
|
virtual |
Set the broker's lookahead.
|
virtual |
Get the broker's lookahead.
|
protected |
Command line setting for the lookahead.