MAKVrExchange::DtBrokerInitializer Class Reference

A class to initialize DtBroker instances. More...

Inheritance diagram for MAKVrExchange::DtBrokerInitializer:

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*.
	DtBrokerInitializer (const DtBrokerInitializer &other)
	Copy CTOR.
virtual	~DtBrokerInitializer ()
	Destructor.
DtBrokerInitializer &	operator= (const DtBrokerInitializer &other)
	Assignment Operator.
virtual DtBrokerInitializer *	clone () const
	Clone method.
virtual void	parseCmdLine ()
	Parse the command line.
virtual void	loadFile ()
	Load a configuration file.
virtual void	loadFile (const DtString &fileName)
virtual bool	saveFile ()
	Save a configuration file.
virtual bool	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)
virtual DtString	logFileName () const
	Returns the name of the log file to use.
virtual void	setLogFileName (const DtString &lfn)
virtual bool	isLogTimestampingEnabled () const
	Returns whether log file timestamps are enabled.
virtual void	setLogTimestampingEnabled (bool timestamp)
virtual int	logRollingInterval () const
	Returns the length of the interval at which log files are rolled.
virtual void	setLogRollingInterval (int intervalInSeconds)
virtual DtTime	lockFailureTimeout () const
	Returns the length of the time to wait for a successful shared memory lock.
virtual void	setLockFailureTimeout (DtTime timeInSeconds)
virtual DtString	pluginDirectory () const
	Returns the name of the plugin directory 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	locationFilteringInterval () const
	Returns the location filtering interval (in seconds).
virtual void	setLocationFilteringInterval (DtTime t)
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 > &	disablePublishTranslatorSet () const
	Returns a list of translators who are disabled for writing (publishing).
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).
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.
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.
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.
virtual DtString	qtTranslatorLocale ()
	Returns the string of the translatorLocale passed in on the command line.

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< 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

Detailed Description

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.

Examples

• Simple Broker Example

Constructor & Destructor Documentation

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 MAKVrExchange::DtBrokerInitializer::~DtBrokerInitializer ( )

virtual

Destructor.

Member Function Documentation

virtual void MAKVrExchange::DtBrokerInitializer::addDebuggedTranslator ( const DtString &  )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::addDisablePublishTranslator ( const DtString &  )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::addDisableReflectTranslator ( const DtString &  )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::addObjectFilter ( const DtObjectFilter &  filter )

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 DtString MAKVrExchange::DtBrokerInitializer::brokerName ( ) const

virtual

The name of this broker.

Referenced by MAKVrExchange::DtBroker::brokerName().

virtual DtBrokerInitializer* MAKVrExchange::DtBrokerInitializer::clone ( ) const

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 DtString MAKVrExchange::DtBrokerInitializer::controlQueueName ( ) const

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 const std::vector<DtString>& MAKVrExchange::DtBrokerInitializer::debuggedTranslators ( ) const

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.

Returns

A list of translator names.

virtual const std::vector<DtString>& MAKVrExchange::DtBrokerInitializer::disablePublishTranslatorSet ( ) const

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.

Returns

A list of translator names.

virtual const std::vector<DtString>& MAKVrExchange::DtBrokerInitializer::disableReflectTranslatorSet ( ) const

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.

Returns

A list of translator names.

virtual bool MAKVrExchange::DtBrokerInitializer::dumpEnvironment ( ) const

virtual

The broker can be configured to dump its known environment at startup.

This can be helpful in debugging.

DtString MAKVrExchange::DtBrokerInitializer::fileName ( ) const

inlinevirtual

Returns the name of the file that this initializer refers to.

References myMtlFileName.

const std::vector< DtGeoLocationFilter > & MAKVrExchange::DtBrokerInitializer::geoLocationFilters ( ) const

inlinevirtual

References myObjectGeoLocationFilters.

virtual DtString MAKVrExchange::DtBrokerInitializer::interactionQueueName ( ) const

virtual

virtual bool MAKVrExchange::DtBrokerInitializer::isLogTimestampingEnabled ( ) const

virtual

Returns whether log file timestamps are enabled.

virtual void MAKVrExchange::DtBrokerInitializer::loadFile ( )

virtual

Load a configuration file.

virtual void MAKVrExchange::DtBrokerInitializer::loadFile ( const DtString &  fileName )

virtual

virtual DtTime MAKVrExchange::DtBrokerInitializer::locationFilteringInterval ( ) const

virtual

Returns the location filtering interval (in seconds).

virtual DtTime MAKVrExchange::DtBrokerInitializer::lockFailureTimeout ( ) const

virtual

Returns the length of the time to wait for a successful shared memory lock.

virtual DtString MAKVrExchange::DtBrokerInitializer::logFileName ( ) const

virtual

Returns the name of the log file to use.

If the logFileName is "" then a file is not used for logging.

virtual int MAKVrExchange::DtBrokerInitializer::logRollingInterval ( ) const

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.

const std::vector< DtString > & MAKVrExchange::DtBrokerInitializer::markingFilters ( ) const

inlinevirtual

References myObjectMarkingFilters.

virtual int MAKVrExchange::DtBrokerInitializer::maxControlMessages ( ) const

virtual

Returns the maximum number of control messages to read per tic.

virtual int MAKVrExchange::DtBrokerInitializer::maxInteractionMessages ( ) const

virtual

Returns the maximum number of Interaction messages to read per tick.

virtual int MAKVrExchange::DtBrokerInitializer::maxObjectMessages ( ) const

virtual

Returns the maximum number of object messages to read per tick.

const std::vector< DtString > & MAKVrExchange::DtBrokerInitializer::nameFilters ( ) const

inlinevirtual

References myObjectNameFilters.

virtual int MAKVrExchange::DtBrokerInitializer::notifyLevel ( ) const

virtual

The notify level of this broker.

virtual DtString MAKVrExchange::DtBrokerInitializer::objectQueueName ( ) const

virtual

virtual bool MAKVrExchange::DtBrokerInitializer::oneToOneMapping ( ) const

virtual

Broker should generate a one to one mapping for translations.

DtBrokerInitializer& MAKVrExchange::DtBrokerInitializer::operator=

(

const DtBrokerInitializer &

other

)

Assignment Operator.

virtual void MAKVrExchange::DtBrokerInitializer::parseCmdLine ( )

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 DtString MAKVrExchange::DtBrokerInitializer::pluginDirectory ( ) const

virtual

Returns the name of the plugin directory to use.

virtual int MAKVrExchange::DtBrokerInitializer::pollingInterval ( ) const

virtual

Returns the interval, in ms, between each call to drainInput() on the exercise connection.

Referenced by MAKVrExchange::DtBroker::pollingInterval().

virtual bool MAKVrExchange::DtBrokerInitializer::printStatistics ( ) const

virtual

Returns whether statistics are printed to the log file.

virtual DtString MAKVrExchange::DtBrokerInitializer::qtTranslatorLocale ( )

virtual

Returns the string of the translatorLocale passed in on the command line.

virtual void MAKVrExchange::DtBrokerInitializer::removeDebuggedTranslator ( const DtString &  )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::removeDisablePublishTranslator ( const DtString &  )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::removeDisableReflectTranslator ( const DtString &  )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::removeObjectFilter ( const DtObjectFilter &  filter )

virtual

virtual bool MAKVrExchange::DtBrokerInitializer::saveFile ( )

virtual

Save a configuration file.

virtual bool MAKVrExchange::DtBrokerInitializer::saveFile ( const DtString &  fileName )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setDebuggedTranslators ( const std::set< DtString > &  debuggedSet )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setDisablePublishTranslators ( const std::set< DtString > &  disabledSet )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setDisableReflectTranslators ( const std::set< DtString > &  disableSet )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setDumpEnvironment ( bool  shouldDumpEnv )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setGeoLocationFilters ( const std::vector< DtGeoLocationFilter > &  filters )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setLocationFilteringInterval ( DtTime  t )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setLockFailureTimeout ( DtTime  timeInSeconds )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setLogFileName ( const DtString &  lfn )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setLogRollingInterval ( int  intervalInSeconds )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setLogTimestampingEnabled ( bool  timestamp )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setMarkingFilters ( const std::vector< DtString > &  filters )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setMaxControlMessages ( int  mcm )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setMaxInteractionMessages ( int  mim )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setMaxObjectMessages ( int  mom )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setNameFilters ( const std::vector< DtString > &  filters )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setNotifyLevel ( int  nl )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setOneToOneMapping ( bool  val )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setPluginDirectory ( const DtString &  lfn )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setPollingInterval ( int  pi )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setPrintStatistics ( bool  val )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setStatisticsReportingInterval ( DtTime  si )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setTcpPort ( int  port )

virtual

virtual void MAKVrExchange::DtBrokerInitializer::setTypeFilters ( const std::vector< DtString > &  filters )

virtual

bool MAKVrExchange::DtBrokerInitializer::showConnectionInfoDialog

(

)

const

Returns true if the broker is given the argument to show the connection info dialog on startup.

virtual DtTime MAKVrExchange::DtBrokerInitializer::statisticsReportingInterval ( ) const

virtual

Returns the statistics reporting interval (in seconds).

virtual int MAKVrExchange::DtBrokerInitializer::tcpPort ( ) const

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.

const std::vector< DtString > & MAKVrExchange::DtBrokerInitializer::typeFilters ( ) const

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.

Member Data Documentation

int MAKVrExchange::DtBrokerInitializer::myArgc

protected

char** MAKVrExchange::DtBrokerInitializer::myArgv

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myCmdLineBrokerName

protected

DtConfigVariable<bool> MAKVrExchange::DtBrokerInitializer::myCmdLineDumpEnvFlag

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myCmdLineNotifyLevel

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myCmdLineTcpPort

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myControlQueueName

protected

DtMultiConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myDebuggedTranslators

protected

DtMultiConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myDisablePublishTranslators

protected

DtMultiConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myDisableReflectTranslators

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myInteractionQueueName

protected

DtConfigVariable<DtTime> MAKVrExchange::DtBrokerInitializer::myLocationFilteringInterval

protected

DtConfigVariable<DtTime> MAKVrExchange::DtBrokerInitializer::myLockFailureTimeout

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myLogFileName

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myLogRollingInterval

protected

DtConfigVariable<bool> MAKVrExchange::DtBrokerInitializer::myLogTimestampingEnabled

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myMaxControlMessages

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myMaxInterMessages

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myMaxObjectMessages

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myMtlFileName

protected

Referenced by fileName().

DtVariableGroup MAKVrExchange::DtBrokerInitializer::myObjectFiltersGroup

protected

DtMultiConfigVariable<DtGeoLocationFilter> MAKVrExchange::DtBrokerInitializer::myObjectGeoLocationFilters

protected

Referenced by geoLocationFilters().

DtMultiConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myObjectMarkingFilters

protected

Referenced by markingFilters().

DtMultiConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myObjectNameFilters

protected

Referenced by nameFilters().

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myObjectQueueName

protected

DtMultiConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myObjectTypeFilters

protected

Referenced by typeFilters().

DtConfigVariable<bool> MAKVrExchange::DtBrokerInitializer::myOneToOneTranslation

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myPluginDirectory

protected

DtConfigVariable<int> MAKVrExchange::DtBrokerInitializer::myPollingInterval

protected

DtConfigVariable<bool> MAKVrExchange::DtBrokerInitializer::myPrintStatisticsFlag

protected

DtString MAKVrExchange::DtBrokerInitializer::myProgramName

protected

DtConfigVariable<DtString> MAKVrExchange::DtBrokerInitializer::myQtTranslatorLocale

protected

DtApplicationSettings MAKVrExchange::DtBrokerInitializer::mySettings

protected

DtConfigVariable<bool> MAKVrExchange::DtBrokerInitializer::myShowInfoDialogFlag

protected

DtConfigVariable<DtTime> MAKVrExchange::DtBrokerInitializer::myStatisticsReportingInterval

protected

DtConfigVariable<bool> MAKVrExchange::DtBrokerInitializer::myUseGuiFlag

protected

DtString MAKVrExchange::DtBrokerInitializer::myVersionString

protected

---

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

• brokerInitializer.h