VR-Exchange 2.2 API Documentation
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
MAKVrExchange::DtPortalApp Class Reference

The DtPortalApp is the main class for the Portal application. More...

Public Types

typedef DtQueueManager *(* DtQueueManagerCreator )(DtU32 numberOfBucketsInQueue, DtU32 payloadSizePerBucket, int port, DtU16 theBroker, const DtString &objectQueueName, const DtString &interactionQueueName, const DtString &controlQueueName)

Public Member Functions

 DtPortalApp (DtPortalAppInitializer &init)
 Constructor.
virtual ~DtPortalApp ()
 Destructor.
virtual void initialize ()
 initializes the App. MUST be called after the constructor
virtual void initFileLogging (const DtString &fileName)
 Initializes File Logging by opening a file named fileName.
virtual int run ()
 Runs the Portal Application.
virtual DtPortalAppGuiportalAppGui ()
 Returns a pointer to the DtPortalAppGui instance.

Static Public Member Functions

static void setQueueManagerCreator (DtQueueManagerCreator func)
 Sets function to use to create the queueManager.

Protected Attributes

DtQueueManagermyQueueManager
bool myUseGuiFlag
bool myOkToShutdownFlag
int myArgc
QApplication * myQtApp
 a fix for qt problem
DtPortalAppGuimyMainWindow
DtPortalAppInitializermyInitializer

Static Protected Attributes

static DtQueueManagerCreator theQueueManagerCreator

Private Member Functions

 DtPortalApp (const DtPortalApp &orig)
 Copy Ctor Not Implemented – Do Not Copy.
DtPortalAppoperator= (const DtPortalApp &orig)
 Assignment Operator Not Implemented – Do Not Copy.

Detailed Description

The DtPortalApp is the main class for the Portal application.

It is responsible for managing all shared memory, keeping track of the brokers and managing a GUI if a GUI was requested by the initializer.

Member Typedef Documentation

typedef DtQueueManager*(* MAKVrExchange::DtPortalApp::DtQueueManagerCreator)(DtU32 numberOfBucketsInQueue, DtU32 payloadSizePerBucket, int port, DtU16 theBroker, const DtString &objectQueueName, const DtString &interactionQueueName, const DtString &controlQueueName)

Constructor & Destructor Documentation

MAKVrExchange::DtPortalApp::DtPortalApp ( DtPortalAppInitializer init)

Constructor.

virtual MAKVrExchange::DtPortalApp::~DtPortalApp ( )
virtual

Destructor.

MAKVrExchange::DtPortalApp::DtPortalApp ( const DtPortalApp orig)
private

Copy Ctor Not Implemented – Do Not Copy.

Member Function Documentation

virtual void MAKVrExchange::DtPortalApp::initialize ( )
virtual

initializes the App. MUST be called after the constructor

DtPortalApp& MAKVrExchange::DtPortalApp::operator= ( const DtPortalApp orig)
private

Assignment Operator Not Implemented – Do Not Copy.

virtual void MAKVrExchange::DtPortalApp::initFileLogging ( const DtString fileName)
virtual

Initializes File Logging by opening a file named fileName.

virtual int MAKVrExchange::DtPortalApp::run ( )
virtual

Runs the Portal Application.

This call does not return until the application exits.

virtual DtPortalAppGui* MAKVrExchange::DtPortalApp::portalAppGui ( )
virtual

Returns a pointer to the DtPortalAppGui instance.

This returns null if VR-Exchange is not running with a GUI.

static void MAKVrExchange::DtPortalApp::setQueueManagerCreator ( DtQueueManagerCreator  func)
static

Sets function to use to create the queueManager.

Member Data Documentation

DtQueueManagerCreator MAKVrExchange::DtPortalApp::theQueueManagerCreator
staticprotected
DtQueueManager* MAKVrExchange::DtPortalApp::myQueueManager
protected
bool MAKVrExchange::DtPortalApp::myUseGuiFlag
protected
bool MAKVrExchange::DtPortalApp::myOkToShutdownFlag
protected
int MAKVrExchange::DtPortalApp::myArgc
protected
QApplication* MAKVrExchange::DtPortalApp::myQtApp
protected

a fix for qt problem

DtPortalAppGui* MAKVrExchange::DtPortalApp::myMainWindow
protected
DtPortalAppInitializer& MAKVrExchange::DtPortalApp::myInitializer
protected

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

Document ID: Generated on Mon Apr 15 17:15:50 EDT 2013 from SVN revision 126154
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)