 |
VR-Exchange 2.7 API Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Exchange 2.7 API Documentation
|
A class to initialize DtBroker instances. More...
Public Member Functions | |
| 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... | |
| DtBrokerInitializer & | operator= (const DtBrokerInitializer &other) |
| Assignment Operator. More... | |
| virtual DtBrokerInitializer * | clone () const |
| Clone method. 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 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 | |
| int | myArgc |
| char ** | myArgv |
| DtString | myProgramName |
| DtString | myVersionString |
| DtApplicationSettings | mySettings |
| 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< bool > | myLogTimestampingEnabled |
| DtConfigVariable< int > | myLogRollingInterval |
| DtConfigVariable< DtTime > | myLockFailureTimeout |
| DtConfigVariable< DtString > | myPluginDirectory |
| DtConfigVariable< bool > | myloadVrfPluginsFlag |
| DtConfigVariable< DtString > | myVrfVersion |
| 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 > | myLocationFilteringInterval |
| DtConfigVariable< DtTime > | myStatisticsReportingInterval |
| DtConfigVariable< bool > | myPrintStatisticsFlag |
| DtMultiConfigVariable< DtString > | myDebuggedTranslators |
| DtMultiConfigVariable< DtString > | myDisablePublishTranslators |
| DtMultiConfigVariable< DtString > | myDisableReflectTranslators |
| DtConfigVariable< DtString > | myQtTranslatorLocale |
| DtVariableGroup | myObjectFiltersGroup |
| DtMultiConfigVariable< DtString > | myObjectNameFilters |
| DtMultiConfigVariable< DtString > | myObjectTypeFilters |
| DtMultiConfigVariable< DtString > | myObjectMarkingFilters |
| DtMultiConfigVariable < DtGeoLocationFilter > | myObjectGeoLocationFilters |
A class to initialize DtBroker instances.
This class is used to initialize a DtBroker instance. Because brokers are used in standalone applications which are started by the portal, initial values come from both the command line and an MTL file. Much of the command line needs to be consistant between brokers, one such parameter is -l, the MTL file to read. This class will look for the -l command line and the file name that comes after it. That MTL file will then be processed. This class is defined in libBroker.
| 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*.
| MAKVrExchange::DtBrokerInitializer::DtBrokerInitializer | ( | const DtBrokerInitializer & | other | ) |
Copy CTOR.
|
virtual |
Destructor.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
| int& MAKVrExchange::DtBrokerInitializer::argc | ( | ) |
The argument count as passed in the CTOR.
| char** MAKVrExchange::DtBrokerInitializer::argv | ( | ) |
The argument list as passed in the CTOR.
|
virtual |
The name of this broker.
Referenced by MAKVrExchange::DtBroker::brokerName().
|
virtual |
Clone method.
Creates a copy of this initializer - caller is responsible for deletion.
Reimplemented in MAKVrExchange::DtRprBroker::DtRprBrokerInitializer, MAKVrExchange::DtTenaBroker::DtTenaBrokerInitializer, MAKVrExchange::DtDdsBroker::DtDdsBrokerInitializer, and MAKVrExchange::DtDisBroker::DtDisBrokerInitializer.
|
virtual |
Returns the queue names for each type of queue.
Queues are set through the command line by the portal that is controlling this broker.
|
virtual |
Returns a list of translators who's debugging is enabled.
This list of translator names is assembled by reading the broker's .mtl configuration file for the "debuggedTranslators" parameter.
|
virtual |
Returns a list of translators who are disabled for writing (publishing).
This list of translator names is assembled by reading the broker's .mtl configuration file for the "disablePublishTranslators" parameter.
|
virtual |
Returns a list of translators who are disabled for reading (reflecting).
This list of translator names is assembled by reading the broker's .mtl configuration file for the "disableReflectTranslators" parameter.
|
virtual |
The broker can be configured to dump its known environment at startup.
This can be helpful in debugging.
|
inlinevirtual |
Returns the name of the file that this initializer refers to.
References myMtlFileName.
|
inlinevirtual |
References myObjectGeoLocationFilters.
|
virtual |
|
virtual |
Returns whether log file timestamps are enabled.
|
virtual |
Load a configuration file.
|
virtual |
|
virtual |
Whether to load the VR-Forces Plugins.
|
virtual |
Returns the location filtering interval (in seconds).
|
virtual |
Returns the length of the time to wait for a successful shared memory lock.
|
virtual |
Returns the name of the log file to use.
If the logFileName is "" then a file is not used for logging.
|
virtual |
Returns the length of the interval at which log files are rolled.
The interval is the length of time in seconds between log rotation.
|
inlinevirtual |
References myObjectMarkingFilters.
|
virtual |
Returns the maximum number of control messages to read per tic.
|
virtual |
Returns the maximum number of Interaction messages to read per tick.
|
virtual |
Returns the maximum number of object messages to read per tick.
|
inlinevirtual |
References myObjectNameFilters.
|
virtual |
The notify level of this broker.
|
virtual |
|
virtual |
Broker should generate a one to one mapping for translations.
| DtBrokerInitializer& MAKVrExchange::DtBrokerInitializer::operator= | ( | const DtBrokerInitializer & | other | ) |
Assignment Operator.
|
virtual |
Parse the command line.
This method will parse the command line and set values according to what options have been set on the command line. This should be called by the creator of this instance. In addition this will load the configuration file specified by the -l argument (broker.bcf by default)
|
virtual |
Returns the name of the plugin directory to use.
|
virtual |
Returns the interval, in ms, between each call to drainInput() on the exercise connection.
Referenced by MAKVrExchange::DtBroker::pollingInterval().
|
virtual |
Returns whether statistics are printed to the log file.
|
virtual |
Returns the string of the translatorLocale passed in on the command line.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Save a configuration file.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
| bool MAKVrExchange::DtBrokerInitializer::showConnectionInfoDialog | ( | ) | const |
Returns true if the broker is given the argument to show the connection info dialog on startup.
|
virtual |
Returns the statistics reporting interval (in seconds).
|
virtual |
TCP port to use to maintain connectivity with the Data Exchange.
The Default is 5111, and setting this to 0 will disable this functionality.
|
inlinevirtual |
References myObjectTypeFilters.
| bool MAKVrExchange::DtBrokerInitializer::useGui | ( | ) | const |
Returns true if the broker can use a GUI.
This can be disabled via a command line argument or by not having the DISPLAY variable set.
|
virtual |
VR-Forces version number (used in conjuction with plugin directory to load correct version).
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by fileName().
|
protected |
|
protected |
Referenced by geoLocationFilters().
|
protected |
Referenced by markingFilters().
|
protected |
Referenced by nameFilters().
|
protected |
|
protected |
Referenced by typeFilters().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |