MAKVrExchange::DtVrlBroker Class Reference

DtVrlBroker is the base class for all brokers based on a VR-Link connection. More...

Inheritance diagram for MAKVrExchange::DtVrlBroker:

Public Member Functions
	DtVrlBroker ()
	CTOR.
virtual	~DtVrlBroker ()
	Virtual DTOR.
virtual DtExerciseConn *	connection () const
	Returns a pointer to the HLA DtExerciseConnection.
Public Member Functions inherited from MAKVrExchange::DtBroker
virtual	~DtBroker ()
	Default DTOR.
virtual DtPortalConnection *	portalConnection () const
	Returns a pointer to the portal connection.
virtual void	launchGui ()=0
	Function which is called when VR-Exchange wants a display launched for this broker.
virtual void	launchInfoGui ()
	Override of the pure virtual function from DtBroker.
virtual void	reloadBrokerSettings ()
	Function used to make the broker reload its broker initialization settings.
virtual void	reloadFilterSettings ()
	Function used to make the broker reload its filter settings.
virtual const DtString	brokerName () const
	Returns the brokers name.
virtual DtU16	brokerId () const
	Returns the brokers ID.
virtual DtTime	simTime () const
	Returns the current simulation time.
virtual void	updateSimTime () const
	Called to advance the simTime.
virtual bool	isTimeToQuit () const
	Indicates this broker needs to shutdown.
virtual bool	isTranslatorDebuggingOn (const DtString &name) const
	Returns true if the translator name is set for debugging.
virtual bool	isTranslatorDisabled (const DtString &name) const
	Returns true if the translator name is disabled.
virtual DtTime	pollingInterval ()
	Returns the amount of time that the broker is asking to be polled.
virtual DtBrokerInitializer *	brokerInitializer () const
	Returns the brokerInitializer object used to create this broker.
virtual void	tick ()=0
	Tick is called by processEvents, brokers should override to do any periodic processing.
virtual void	processEvents ()
	ProcessEvents should be called every frame. This should not be overrided.
virtual DtFilterManager &	objectFilters ()
	Accessor for the broker's object filter manager.
virtual const DtFilterManager &	objectFilters () const
	Accessor for the broker's object filter manager (const).
virtual void	setBrokerId (int id)
	Set the internal broker ID values of this broker.

Protected Attributes
DtExerciseConn *	myExConn
Protected Attributes inherited from MAKVrExchange::DtBroker
DtU16	myBrokerId
bool	myShutdownRequestedFlag
DtPortalConnection *	myPortalConn
DtBrokerInitializer *	myBrokerInitializer
std::set< DtString >	myDisabledTranslators
std::set< DtString >	myDebuggedTranslators
DtFilterManager	myFilterManager
DtStatisticsManager *	myStatisticsManager
DtPrinter *	myFilePrinter

Additional Inherited Members
Public Types inherited from MAKVrExchange::DtBroker
typedef bool(*	PluginInitMethod )(DtBroker *)
Protected Member Functions inherited from MAKVrExchange::DtBroker
	DtBroker ()
	CTOR.
virtual void	initialize (DtBrokerInitializer *init)
	Initializes the broker using the given initializer.
virtual void	logBrokerSettings (DtBrokerInitializer *init)
	Output important broker settings to the log file on initialization.
virtual void	initializeDebuggedAndDisabledFromInit ()
	Sets our disabled / debugged sets from the initializer.
virtual void	initFileLogging (const DtString &logFileName)
	Log all output to the filename logFileName.
virtual void	obtainLock ()
	Checks lock file to determine if broker is already running.
virtual void	loadBrokerPlugins ()
	Loads all plugins in the broker's plugin directory.
virtual void	getLibrariesInDir (const std::string &dir, std::list< std::string > &files) const
	Scans the given directory for libraries and returns them in a list.
virtual void	initPortalConnection (const DtBrokerInitializer &init)
	Initializes the Portal Connection.
virtual void	initStatisticsManager (const DtBrokerInitializer &init)
	Initialize the statistics manager.
virtual void	stopFileLogging ()
	Cleanup this broker's members.
virtual void	processShutdownRequest (const DtPortalBrokerShutdownRequestMessage &obj)
	Called by the static method shutdownRequestCb to notify this broker to stop.
virtual void	processRestartRequest (bool shouldEnableOneToOne)
	Called by the restart request callback to notify this broker to restart.
virtual void	shutdownWithError (const DtString &error)
	Sends an error message to the queue manager, then marks us for shutdown.
virtual void	filterObjectCallback (const DtFilterObjectMessage &object)
	Processes DtFilterObjectMessage messages.
Static Protected Member Functions inherited from MAKVrExchange::DtBroker
static void	shutdownRequestCb (const DtPortalBrokerShutdownRequestMessage &obj, void *usr)
	Portal Connection Callback, registered in the CTOR.
static void	processDisableOneToOneCb (const DtPortalBrokerDisableOneToOneMessage &msg, void *usr)
	Portal broker process disable One to One mapping callback.
static void	processEnableOneToOneCb (const DtPortalBrokerEnableOneToOneMessage &msg, void *usr)
	Portal broker process enable One to One mapping callback.
static void	launchGuiRequestCb (const DtBrokerLaunchGuiRequest &obj, void *usr)
	Portal Connection Callback, registered in the CTOR.
static void	filterObjectCallback (const DtFilterObjectMessage &object, void *userData)
	Callback method for processing DtFilterObjectMessage messages.
Static Protected Attributes inherited from MAKVrExchange::DtBroker
static const char *	theVrxPluginInitMethod

Detailed Description

DtVrlBroker is the base class for all brokers based on a VR-Link connection.

Constructor & Destructor Documentation

MAKVrExchange::DtVrlBroker::DtVrlBroker

(

)

CTOR.

virtual MAKVrExchange::DtVrlBroker::~DtVrlBroker ( )

virtual

Virtual DTOR.

Member Function Documentation

DtExerciseConn * MAKVrExchange::DtVrlBroker::connection ( ) const

inlinevirtual

Returns a pointer to the HLA DtExerciseConnection.

References myExConn.

Member Data Documentation

DtExerciseConn* MAKVrExchange::DtVrlBroker::myExConn

protected

Referenced by connection().

---

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

• vrlBroker.h