VR-Exchange 2.1 API Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtSimpleBroker Class Reference
Inheritance diagram for DtSimpleBroker:
Inheritance graph
[legend]

Public Member Functions

 DtSimpleBroker (MAKVrExchange::DtBrokerInitializer *init)
virtual ~DtSimpleBroker ()
virtual DtExerciseConn * disExConn ()
- Public Member Functions inherited from MAKVrExchange::DtBroker
 DtBroker (DtBrokerInitializer *init)
 Default constructor.
virtual ~DtBroker ()
 Default DTOR.
virtual DtPortalConnectionportalConnection () const
 Returns a pointer to the portalConnection.
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 ()
 the amount of time that the broker is asking to be polled.
virtual DtBrokerInitializerbrokerInitializer () const
 Returns the brokerInitializer object used to create this broker.
virtual void processEvents ()
 ProcessEvents should be called every frame. This should not be overrided.
virtual DtFilterManagerobjectFilters ()
 Accessor for the broker's object filter manager.
virtual const DtFilterManagerobjectFilters () 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 Member Functions

virtual void tick ()
 Tick is called by processEvents, brokers should override to do any periodic processing.
virtual void launchGui ()
 Function which is called when VR-Exchange wants a display launched for this broker.
- Protected Member Functions inherited from MAKVrExchange::DtBroker
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 initPortalConnection (const DtBrokerInitializer &init)
 Initializes the Portal Connection, called from the CTOR.
virtual void initFileLogging (const DtString &logFileName)
 Log all output to the filename logFileName, called from the CTOR.
virtual void shutdownWithError (const DtString &error)
 Sends an error message to the queue manager, then marks us for shutdown.
virtual void initializeDebuggedAndDisabledFromInit ()
 Sets our disabled / debugged sets from the initializer.
virtual void filterObjectCallback (const DtFilterObjectMessage &object)
 Processes DtFilterObjectMessage messages.

Protected Attributes

DtExerciseConn * myDisExConn
DtFireTranslatormyFireTranslator
DtEntityTranslatormyEntityTranslator
- Protected Attributes inherited from MAKVrExchange::DtBroker
DtU16 myBrokerId
bool myShutdownRequestedFlag
DtPortalConnectionmyPConn
DtBrokerInitializermyBrokerInitializer
std::set< DtStringmyDisabledTranslators
std::set< DtStringmyDebuggedTranslators
DtFilterManager myFilterManager
DtPrinter * myFilePrinter

Additional Inherited Members

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

Constructor & Destructor Documentation

DtSimpleBroker::DtSimpleBroker ( MAKVrExchange::DtBrokerInitializer init)
virtual DtSimpleBroker::~DtSimpleBroker ( )
virtual

Member Function Documentation

virtual DtExerciseConn* DtSimpleBroker::disExConn ( )
virtual
virtual void DtSimpleBroker::tick ( )
protectedvirtual

Tick is called by processEvents, brokers should override to do any periodic processing.

Implements MAKVrExchange::DtBroker.

virtual void DtSimpleBroker::launchGui ( )
protectedvirtual

Function which is called when VR-Exchange wants a display launched for this broker.

Implements MAKVrExchange::DtBroker.

Member Data Documentation

DtExerciseConn* DtSimpleBroker::myDisExConn
protected
DtFireTranslator* DtSimpleBroker::myFireTranslator
protected
DtEntityTranslator* DtSimpleBroker::myEntityTranslator
protected

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

Document ID: Generated on Tue Aug 7 22:07:13 EDT 2012 from SVN revision 117874
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)