MAKVrExchange::DtBrokerInitializer Class Reference

This class is used to initialize a DtBroker instance. 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 *.
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< 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
	DtBrokerInitializer (const DtBrokerInitializer &other)
	Copy CTOR not implemented, this class can not be copied yet.

Detailed Description

This class is used to initialize a DtBroker instance.

A class to initialize DtBroker instances.

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

virtual MAKVrExchange::DtBrokerInitializer::~DtBrokerInitializer ( )

virtual

Destructor.

MAKVrExchange::DtBrokerInitializer::DtBrokerInitializer ( const DtBrokerInitializer &  other )

private

Copy CTOR not implemented, this class can not be copied yet.

Member Function Documentation

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

virtual

Load a configuration file.

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

virtual

virtual void MAKVrExchange::DtBrokerInitializer::saveFile ( )

virtual

Save a configuration file.

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

virtual

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

virtual

The name of this broker.

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

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

virtual

The notify level of this broker.

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

virtual

DtString MAKVrExchange::DtBrokerInitializer::logFileName

(

)

const

Returns the name of the log file to use.

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

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

virtual

DtString MAKVrExchange::DtBrokerInitializer::pluginDirectory

(

)

const

Returns the name of the log file to use.

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

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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 void MAKVrExchange::DtBrokerInitializer::setPollingInterval ( int  pi )

virtual

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

virtual

Returns the statistics reporting interval (in seconds).

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

virtual

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

virtual

Returns whether statistics are printed to the log file.

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

virtual

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.

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

virtual

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.

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

virtual

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

virtual

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

virtual

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

virtual

Broker should generate a one to one mapping for translations.

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

virtual

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 void MAKVrExchange::DtBrokerInitializer::addDebuggedTranslator ( const DtString &  )

virtual

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

virtual

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

virtual

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

virtual

Returns a list of translators who are disabled.

This list of translator names is assembled by reading the broker's .mtl configuration file for the "disabledTranslators" parameter.

Returns

A list of translator names.

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

virtual

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

virtual

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

virtual

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.

bool MAKVrExchange::DtBrokerInitializer::showConnectionInfoDialog

(

)

const

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

int& MAKVrExchange::DtBrokerInitializer::argc

(

)

The argument count as passed in the CTOR.

char** MAKVrExchange::DtBrokerInitializer::argv

(

)

The argument list as passed in the CTOR.

DtCmdLine::CmdLine& MAKVrExchange::DtBrokerInitializer::cmdLine

(

)

Returns a reference to the CMD Line Object.

const std::vector< DtObjectFilter > & MAKVrExchange::DtBrokerInitializer::objectFilters ( ) const

inline

A list of all objects set for filtering in this broker.

References myFilterManagerConfig.

virtual void MAKVrExchange::DtBrokerInitializer::setObjectFilters ( const std::vector< DtObjectFilter > &  filters )

virtual

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

virtual

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

virtual

DtString MAKVrExchange::DtBrokerInitializer::fileName ( ) const

inline

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

References myMtlFileName.

Member Data Documentation

DtConfigVariable<bool>* MAKVrExchange::DtBrokerInitializer::myShowInfoDialogFlag

protected

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myMtlFileName

protected

Referenced by fileName().

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myCmdLineBrokerName

protected

DtConfigVariable<int>* MAKVrExchange::DtBrokerInitializer::myCmdLineTcpPort

protected

DtConfigVariable<int>* MAKVrExchange::DtBrokerInitializer::myCmdLineNotifyLevel

protected

DtConfigVariable<bool>* MAKVrExchange::DtBrokerInitializer::myCmdLineDumpEnvFlag

protected

DtConfigVariable<bool>* MAKVrExchange::DtBrokerInitializer::myUseGuiFlag

protected

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myLogFileName

protected

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myPluginDirectory

protected

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myControlQueueName

protected

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myInteractionQueueName

protected

DtConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myObjectQueueName

protected

DtConfigVariable<bool>* MAKVrExchange::DtBrokerInitializer::myOneToOneTranslation

protected

DtConfigVariable<int>* MAKVrExchange::DtBrokerInitializer::myMaxControlMessages

protected

DtConfigVariable<int>* MAKVrExchange::DtBrokerInitializer::myMaxInterMessages

protected

DtConfigVariable<int>* MAKVrExchange::DtBrokerInitializer::myMaxObjectMessages

protected

DtConfigVariable<int>* MAKVrExchange::DtBrokerInitializer::myPollingInterval

protected

DtConfigVariable<DtTime>* MAKVrExchange::DtBrokerInitializer::myStatisticsReportingInterval

protected

DtConfigVariable<bool>* MAKVrExchange::DtBrokerInitializer::myPrintStatisticsFlag

protected

DtMultiConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myDebuggedTranslators

protected

DtMultiConfigVariable<DtString>* MAKVrExchange::DtBrokerInitializer::myDisabledTranslators

protected

DtMultiConfigVariable<DtObjectFilter>* MAKVrExchange::DtBrokerInitializer::myFilterManagerConfig

protected

Referenced by objectFilters().

int MAKVrExchange::DtBrokerInitializer::myArgc

protected

char** MAKVrExchange::DtBrokerInitializer::myArgv

protected

DtString MAKVrExchange::DtBrokerInitializer::myProgramName

protected

DtString MAKVrExchange::DtBrokerInitializer::myVersionString

protected

DtApplicationSettings MAKVrExchange::DtBrokerInitializer::mySettings

protected

---

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

• brokerInitializer.h