 |
WebLVC 1.8 API Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
WebLVC 1.8 API Documentation
|
DtVrlBroker is the base class for all brokers based on a VR-Link connection. More...
Public Types | |
| typedef DtVrlBroker< T_ExConn > | ParentClass |
 Public Types inherited from MAKVrExchange::DtBroker | |
| typedef bool(* | PluginInitMethod )(DtBroker *) |
| typedef void(* | PluginReloadMethod )(DtBroker *) |
| typedef void(* | PluginPostInitMethod )(DtBroker *) |
| typedef void(* | PluginUnloadMethod )(DtBroker *) |
| typedef void(* | BrokerReloadCallback )(void *) |
| typedef DtTranslatorFactory < DtInteractionTranslator > | DtInteractionTranslatorFactory |
| typedef DtTranslatorFactory < DtObjectTranslator > | DtObjectTranslatorFactory |
Public Member Functions | |
| DtVrlBroker () | |
| CTOR. More... | |
| virtual | ~DtVrlBroker () |
| Virtual DTOR. More... | |
| virtual T_ExConn * | connection () const |
| Returns a pointer to the DtExerciseConn. More... | |
| virtual void | shutdown () |
| Shut down the broker. More... | |
| Public Member Functions inherited from MAKVrExchange::DtBroker | |
| virtual | ~DtBroker () |
| Default DTOR. More... | |
| virtual DtPortalConnection * | portalConnection () const |
| Returns a pointer to the portal connection. More... | |
| virtual void | initializeUi (DtGenericUserInterface *ui) |
| Function called to start the GUI, this could be Qt, Text, Null, or anything else. More... | |
| virtual void | startBroker () |
| Tells the broker to start processing messages and translating. More... | |
| virtual void | launchGui () |
| Function which is called when VR-Exchange wants a display launched for this broker. More... | |
| virtual void | launchInfoGui () |
| Override of the pure virtual function from DtBroker. More... | |
| virtual DtInteractionTranslatorFactory * | interactionTranslatorFactory () |
| Returns a pointer to the interactionTranslatorFactory. More... | |
| virtual DtObjectTranslatorFactory * | objectTranslatorFactory () |
| Returns a pointer to the objectTranslatorFactory. More... | |
| virtual void | reloadTranslatorDebugging () |
| Function used to make the broker reload translator debugging settings. More... | |
| virtual void | reloadBrokerSettings () |
| Function used to make the broker reload its broker initialization settings. More... | |
| virtual const DtString | brokerName () const |
| Returns the brokers name. More... | |
| virtual DtU16 | brokerId () const |
| Returns the brokers ID. More... | |
| virtual DtU32 | brokerType () const |
| Returns the brokers type. More... | |
| virtual DtTime | simTime () const |
| Returns the current simulation time. More... | |
| virtual void | updateSimTime () const |
| Called to advance the simTime. More... | |
| virtual bool | isRunning () const |
| Returns whether the broker is processing messages or not. More... | |
| virtual bool | isTimeToQuit () const |
| Indicates this broker needs to shutdown. More... | |
| virtual bool | isTranslatorDebuggingOn (const DtString &name) const |
| Returns true if debugging is enabled for the given translator. More... | |
| virtual DtTime | pollingInterval () |
| Returns the amount of time that the broker is asking to be polled. More... | |
| virtual DtBrokerInitializer * | brokerInitializer () const |
| Returns the brokerInitializer object used to create this broker. More... | |
| virtual void | tick () |
| Tick is called by processEvents, this will tick all portal translators. More... | |
| virtual void | processEvents () |
| ProcessEvents should be called every frame. More... | |
| virtual DtFilterManager & | objectFilters () |
| Accessor for the broker's object filter manager. More... | |
| virtual const DtFilterManager & | objectFilters () const |
| Accessor for the broker's object filter manager (const). More... | |
| virtual void | setBrokerId (int id) |
| Set the internal broker ID values of this broker. More... | |
| virtual void | shutdownWithError (const DtString &error) |
| Sends an error message to the queue manager, then marks us for shutdown. More... | |
| virtual DtObjectTranslator * | getObjectTranslator (const DtString &name) |
| get an object translator by name More... | |
| virtual DtInteractionTranslator * | getInteractionTranslator (const DtString &name) |
| get an interaction translator by name More... | |
| virtual void | loadTranslators () |
| Updates the GUI with the translators being loaded and initializes them. More... | |
| virtual void | initializeTranslators (DtStringSet &failedTranslators) |
| Loads the translators and populates the list with failures. More... | |
| virtual void | loadKnownObjectTranslators (DtStringSet &failedTranslators) |
| Creates an interaction translator instance for each translator within myObjectTranslatorFactory. More... | |
| virtual void | loadKnownInteractionTranslators (DtStringSet &failedTranslators) |
| Creates an interaction translator instance for each translator within myInteractionTranslatorFactory. More... | |
| virtual bool | loadObjectTranslator (const DtString &translatorName) |
| Creates a translator instance using the translator name passed. More... | |
| virtual bool | loadInteractionTranslator (const DtString &translatorName) |
| Creates an interaction translator instance using the translator name passed. More... | |
| virtual void | addBrokerReloadCallback (BrokerReloadCallback cb, void *usr) |
| Add a callback to be called when the broker restarts. More... | |
| virtual void | callBrokerReloadCallbacks () |
| Call all registered broker reload callbacks. More... | |
| virtual void | setVrfRemoteController (makVrf::DtVrlinkVrfRemoteController *vrfRC) |
| Set and get the VRF Remote Controller pointer from the broker. More... | |
| virtual makVrf::DtVrlinkVrfRemoteController * | vrfRemoteController () |
| virtual void | setDarkModeEnabled (bool flag) |
| Set and get the dark mode toggle. More... | |
| virtual bool | darkModeEnabled () |
Protected Attributes | |
| T_ExConn * | myExConn |
| Protected Attributes inherited from MAKVrExchange::DtBroker | |
| NamedInteractionTranslatorMap | myInteractionTranslatorMap |
| NamedObjectTranslatorMap | myObjectTranslatorMap |
| DtInteractionTranslatorFactory | myInteractionTranslatorFactory |
| DtObjectTranslatorFactory | myObjectTranslatorFactory |
| BrokerPluginsMap | myBrokerPlugins |
| CallbackPairList | myBrokerReloadCallbacks |
| DtGenericUserInterface * | myUi |
| DtU16 | myBrokerId |
| DtU32 | myBrokerType |
| bool | myBrokerIsRunning |
| bool | myShutdownRequestedFlag |
| DtPortalConnection * | myPortalConn |
| DtBrokerInitializer * | myBrokerInitializer |
| std::set< DtString > | myDebuggedTranslators |
| DtFilterManager | myFilterManager |
| DtStatisticsManager * | myStatisticsManager |
| DtFilePrinter * | myFilePrinter |
| makVrf::DtVrlinkVrfRemoteController * | myVrfRemoteController |
| bool | myDarkModeEnabled |
Additional Inherited Members | |
| Protected Types inherited from MAKVrExchange::DtBroker | |
| typedef std::map< const DtString, DtInteractionTranslator * > | NamedInteractionTranslatorMap |
| typedef std::map< const DtString, DtObjectTranslator * > | NamedObjectTranslatorMap |
| typedef std::map< std::string, DtDynamicLibrary * > | BrokerPluginsMap |
| typedef std::list< CallbackPair > | CallbackPairList |
| Protected Member Functions inherited from MAKVrExchange::DtBroker | |
| DtBroker () | |
| CTOR. More... | |
| virtual void | initialize (DtBrokerInitializer *init) |
| Performs one time initialization logic and calls ::initialize(). More... | |
| virtual void | initialize () |
| Performs broker initialization logic. More... | |
| virtual void | logBrokerSettings (DtBrokerInitializer *init) |
| Output important broker settings to the log file on initialization. More... | |
| virtual void | initializeDebuggedAndDisabledFromInit () |
| Sets our disabled / debugged sets from the initializer. More... | |
| virtual void | initFileLogging (const DtBrokerInitializer &init) |
| Log all output to the filename logFileName. More... | |
| virtual void | obtainLock () |
| Checks lock file to determine if broker is already running. More... | |
| virtual void | loadBrokerPlugins () |
| Loads all plugins in the broker's plugin directory. More... | |
| virtual void | scanForPlugins (const std::string &dir, std::list< std::string > &files) const |
| Scans the given directory for plugin libraries and returns them in a list. More... | |
| virtual void | postInitializePlugins () |
| Perform post-initialization logic for plugins. More... | |
| virtual void | reloadBrokerPlugins () |
| Function used to tell broker plugins a reload is occurring. More... | |
| virtual void | initPortalConnection (const DtBrokerInitializer &init) |
| Initializes the Portal Connection. More... | |
| virtual void | initStatisticsManager (const DtBrokerInitializer &init) |
| Initialize the statistics manager. More... | |
| virtual void | stopFileLogging () |
| Cleanup this broker's members. More... | |
| virtual void | processShutdownRequest (const DtPortalBrokerShutdownRequestMessage &obj) |
| Called by the static method shutdownRequestCb to notify this broker to stop. More... | |
| virtual void | processRestartRequest (bool shouldEnableOneToOne) |
| Called by the restart request callback to notify this broker to restart. More... | |
| virtual void | reportLoadTranslatorFailures (const DtStringSet &failedTranslators) const |
| Display errors to end-user. More... | |
| virtual void | objectDiscovered (const DtBrokerObject *brokerObject) |
| Called through a static callback when a DtBrokerObject is discovered. More... | |
| virtual void | objectUpdated (const DtBrokerObject *brokerObject) |
| Called through a static callback when a DtBrokerObject is updated. More... | |
| virtual void | objectRemoved (const DtBrokerObject *brokerObject) |
| Called through a static callback when a DtBrokerObject is removed. More... | |
| virtual bool | addTranslator (DtInteractionTranslator *intTrans, bool reflectEnabled, bool publishEnabled) |
| Adds an already created interactionTranslator to the brokers list. More... | |
| virtual bool | addTranslator (DtObjectTranslator *objTrans, bool reflectEnabled, bool publishEnabled) |
| Adds an already created objectTranslator to the brokers list. More... | |
| virtual void | filterObjectCallback (const DtFilterObjectMessage &object) |
| Processes DtFilterObjectMessage messages. More... | |
| Static Protected Member Functions inherited from MAKVrExchange::DtBroker | |
| static void | shutdownRequestCb (const DtPortalBrokerShutdownRequestMessage &obj, void *usr) |
| Portal Connection Callback, registered in the CTOR. More... | |
| static void | processDisableOneToOneCb (const DtPortalBrokerDisableOneToOneMessage &msg, void *usr) |
| Portal broker process disable One to One mapping callback. More... | |
| static void | processEnableOneToOneCb (const DtPortalBrokerEnableOneToOneMessage &msg, void *usr) |
| Portal broker process enable One to One mapping callback. More... | |
| static void | startRequestCb (const DtBrokerStartRequest &obj, void *usr) |
| Portal Connection Callback, registered in the CTOR. More... | |
| static void | launchGuiRequestCb (const DtBrokerLaunchGuiRequest &obj, void *usr) |
| Portal Connection Callback, registered in the CTOR. More... | |
| static void | objectDiscoveredCallback (const DtBrokerObject *brokerObject, void *usr) |
| static void | objectUpdatedCallback (const DtBrokerObject *brokerObject, void *usr) |
| static void | objectRemovedCallback (const DtBrokerObject *brokerObject, void *usr) |
| static void | filterObjectCallback (const DtFilterObjectMessage &object, void *userData) |
| Callback method for processing DtFilterObjectMessage messages. More... | |
| Static Protected Attributes inherited from MAKVrExchange::DtBroker | |
| static const char * | theVrxPluginInitMethod |
| static const char * | theVrxPluginReloadMethod |
| static const char * | theVrxPluginPostInitMethod |
| static const char * | theVrxPluginUnloadMethod |
DtVrlBroker is the base class for all brokers based on a VR-Link connection.
| typedef DtVrlBroker<T_ExConn> MAKVrExchange::DtVrlBroker< T_ExConn >::ParentClass |
| MAKVrExchange::DtVrlBroker< T_ExConn >::DtVrlBroker | ( | ) |
CTOR.
|
virtual |
Virtual DTOR.
|
virtual |
Returns a pointer to the DtExerciseConn.
|
virtual |
Shut down the broker.
Overridden to destroy the exercise connection after translators are shut down.
Reimplemented from MAKVrExchange::DtBroker.
Reimplemented in MAKVrExchange::DtRprBroker::DtRprBroker, MAKVrExchange::DtDisBroker::DtDisBroker, and MAKVrExchange::DtDdsBroker::DtDdsBroker.
|
protected |