MAKVrExchange::DtBrokerApp Class Reference

An application framework for a Broker instance. More...

Public Types
typedef DtBroker *(*	DtBrokerCreator )(DtBrokerInitializer *)
	Function prototype for functions that create DtDisBrokers.

Public Member Functions
	DtBrokerApp (DtBrokerInitializer *init)
	Takes a DtDisBrokerInitializer which has already been parsed, and then creates a DtDisBroker instance.
virtual	~DtBrokerApp ()
	Destructor frees memory.
virtual DtBroker *	broker ()
	Returns a pointer to the DtDisBroker instance.
virtual int	showInfoDialog ()
	Runs the broker application in a limited mode.
virtual int	run ()
	Runs the application.

Static Public Member Functions
static void	setBrokerCreator (DtBrokerCreator func)
	Set function used for creating myBroker.
static void	setBrokerDialogCreator (DtBrokerDialogCreator func)
	Set function used for creating the broker dialog.
static void	setBrokerIcon (DtString icon)
	Set function used for selecting the broker Icon.

Protected Attributes
DtGenericUserInterface *	myUi
	The user interface used by the broker.
DtBroker *	myBroker
	The DtBroker Broker object.
QApplication *	myQApp
	A QApplication instance is needed for each Qt application.
DtBrokerThread *	myBrokerThread
	Controls the backend thread.

Static Protected Attributes
static DtBrokerCreator	theBrokerCreator
	The DtDisBroker creation function.
static DtBrokerDialogCreator	theBrokerDialogCreator
static QString	theBrokerIcon

Private Member Functions
	DtBrokerApp (const DtBrokerApp &other)
	Copy constructor not implemented - cannot be copied.
DtBrokerApp &	operator= (const DtBrokerApp &other)
	Assignment operator not implemented – cannot be copied.

Detailed Description

An application framework for a Broker instance.

Member Typedef Documentation

typedef DtBroker*(* MAKVrExchange::DtBrokerApp::DtBrokerCreator)(DtBrokerInitializer *)

Function prototype for functions that create DtDisBrokers.

Constructor & Destructor Documentation

MAKVrExchange::DtBrokerApp::DtBrokerApp

(

DtBrokerInitializer *

init

)

Takes a DtDisBrokerInitializer which has already been parsed, and then creates a DtDisBroker instance.

Parameters

[in]

init

The broker's initialization parameters.

virtual MAKVrExchange::DtBrokerApp::~DtBrokerApp ( )

virtual

Destructor frees memory.

MAKVrExchange::DtBrokerApp::DtBrokerApp ( const DtBrokerApp &  other )

private

Copy constructor not implemented - cannot be copied.

Member Function Documentation

virtual DtBroker* MAKVrExchange::DtBrokerApp::broker ( )

virtual

Returns a pointer to the DtDisBroker instance.

DtBrokerApp& MAKVrExchange::DtBrokerApp::operator= ( const DtBrokerApp &  other )

private

Assignment operator not implemented – cannot be copied.

virtual int MAKVrExchange::DtBrokerApp::run ( )

virtual

Runs the application.

This function will not return until the broker gets a message to shutdown. Any translator replacements to the broker need to go before the call to run.

1. Loads the broker's translators.
2. Processes events for myBroker and myQApp until the broker is shutdown.

static void MAKVrExchange::DtBrokerApp::setBrokerCreator ( DtBrokerCreator  func )

static

Set function used for creating myBroker.

Parameters

[in]

func

The creator function used by the DtDisBrokerApp.

static void MAKVrExchange::DtBrokerApp::setBrokerDialogCreator ( DtBrokerDialogCreator  func )

static

Set function used for creating the broker dialog.

Parameters

[in]

func

The creator function used by the DtDisBrokerApp.

static void MAKVrExchange::DtBrokerApp::setBrokerIcon ( DtString  icon )

static

Set function used for selecting the broker Icon.

virtual int MAKVrExchange::DtBrokerApp::showInfoDialog ( )

virtual

Runs the broker application in a limited mode.

The broker will start without a portal or exercise connection, and will execute the launchGui() method to display its connection property editor. After the window is closed, the broker shuts down.

Member Data Documentation

DtBroker* MAKVrExchange::DtBrokerApp::myBroker

protected

The DtBroker Broker object.

DtBrokerThread* MAKVrExchange::DtBrokerApp::myBrokerThread

protected

Controls the backend thread.

QApplication* MAKVrExchange::DtBrokerApp::myQApp

protected

A QApplication instance is needed for each Qt application.

DtGenericUserInterface* MAKVrExchange::DtBrokerApp::myUi

protected

The user interface used by the broker.

DtBrokerCreator MAKVrExchange::DtBrokerApp::theBrokerCreator

staticprotected

The DtDisBroker creation function.

DtBrokerDialogCreator MAKVrExchange::DtBrokerApp::theBrokerDialogCreator

staticprotected

QString MAKVrExchange::DtBrokerApp::theBrokerIcon

staticprotected

---

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

• brokerApp.h