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

Manages the connection list on the main portal window. More...

Inheritance diagram for MAKVrExchange::DtAppBrokerManager:
Inheritance graph
[legend]

Public Types

enum  { DisplayInformation, Shutdown }

Public Slots

virtual void brokerItemEdited (DtXMLBrokerLauncher &)
 A new broker has been edited internally.
virtual void brokerItemAdded (DtXMLBrokerLauncher &)
 A new broker has been added internally.
virtual void brokerItemRemoved (DtXMLBrokerLauncher &)
 A new broker has been removed internally.
virtual void showBrokerInfoDialogAction ()
 Display information on currently selected broker.
virtual void brokerShutdownBrokerAction ()
 Shutdown currently selected broker.
virtual void brokerRestartBrokerAction ()
 Restart currently selected broker.
virtual void brokerRemoveBrokerAction ()
 Remove currently selected broker from the list.
virtual void brokerEditBrokerAction ()
 Edit the configuration file.
virtual void brokerAddNewBrokerAction ()
 Add a new broker.

Signals

void brokerSelectedRunning (bool)

Public Member Functions

 DtAppBrokerManager (QWidget *parent, DtPortalAppInitializer *init, DtPortalConnection *pconn)
virtual ~DtAppBrokerManager ()
 Destructor.
virtual void setBrokerInitLists (std::vector< DtXMLBrokerLauncher > vector)
 If you want the broker manager to re-start brokers, it needs to know how to do that.
virtual DtString lookupBrokerName (const DtU16 &brokerId) const
 look up a broker name given its ID
virtual DtU16 lookupBrokerId (const DtString &brokerName) const
 look up a broker ID given its Name
virtual void setOneToOne (bool val)
 Set One To One mapping of Broker's initializer so app broker manager has the same settings as the portal.
virtual const QTreeWidgettreeWidget () const
 Const accessor for the tree widget.
virtual QTreeWidgettreeWidget ()
 Accessor for the tree widget.

Protected Types

enum  { ShutdownBroker = 1 }
typedef std::map< DtU16, DtStringBrokerIdToNameMap

Protected Slots

virtual void brokerItemDoubleClicked (QTreeWidgetItem *item)
 callback for when an broker is double clicked.
virtual void brokerItemRightButtonPressed (QTreeWidgetItem *item, const QPoint &point)
 callback for when an broker is right clicked.
virtual void brokerSelectionChanged ()
 Broker item has changed. Used for color swapping.

Protected Member Functions

virtual void processAddBrokerMessage (const DtBrokerStartedMessage &msg)
 processes an brokerAddMessage by adding the broker name to the broker list
virtual void processRemoveBrokerMessage (const DtBrokerExitingMessage &msg)
 processes an brokerRemove message from the portal by removing the name from the list
virtual void processAbnormalRemoval (const DtAbnormalBrokerExitMessage &msg)
 processes an abnormal removal message and then called processRemoveBrokerMessage
virtual void launchBrokerForItem (QTreeWidgetItem *item)
 launches the broker which is represented by this item
virtual void shutdownBrokerForItem (QTreeWidgetItem *item)
 shutdown the broker which is represented by this item
virtual DtString createBrokerStartupCommand (const DtXMLBrokerLauncher &brokerLauncher)
 creates a base common command line to start a broker
virtual bool eventFilter (QObject *obj, QEvent *event)

Static Protected Member Functions

static void discoverBrokerCb (const DtBrokerStartedMessage &msg, void *usrData)
 a callback registered with the portal, to be called when a new broker is discovered
static void removeBrokerCb (const DtBrokerExitingMessage &msg, void *usrData)
 a callback registered with the portal, to be called when an broker is deleted
static void abnormalRemovalCb (const DtAbnormalBrokerExitMessage &msg, void *usrData)
 a callback registered with the portal, to be called when an broker is suspiciously removed

Protected Attributes

enum
MAKVrExchange::DtAppBrokerManager:: { ... }  
BrokerPopupMenuPosition
Ui::DtBrokerList myUi
std::vector< DtXMLBrokerLaunchermyBrokerLaunchers
QMenumyPopupMenu
 A popup menu used for the selected broker.
QMenumyDisabledPopupMenu
QMenumyUnselectedPopupMenu
DtPortalConnectionmyPConn
DtPortalAppInitializermyInitializer
DtBrokerEditormyBrokerEditor

Private Member Functions

 DtAppBrokerManager (const DtAppBrokerManager &orig)
 Copy Ctor Not Implemented.
DtAppBrokerManageroperator= (const DtAppBrokerManager &orig)
 Assignment Operator Not Implemented.

Detailed Description

Manages the connection list on the main portal window.

This class is responsible for populating that window by registering to discover brokers and removing then when they are deleted. It is also responsible for sending messages to the broker to display their dialog box

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum
Enumerator:
DisplayInformation 
Shutdown 
anonymous enum
protected
Enumerator:
ShutdownBroker 

Constructor & Destructor Documentation

MAKVrExchange::DtAppBrokerManager::DtAppBrokerManager ( QWidget parent,
DtPortalAppInitializer init,
DtPortalConnection pconn 
)
virtual MAKVrExchange::DtAppBrokerManager::~DtAppBrokerManager ( )
virtual

Destructor.

MAKVrExchange::DtAppBrokerManager::DtAppBrokerManager ( const DtAppBrokerManager orig)
private

Copy Ctor Not Implemented.

Member Function Documentation

virtual void MAKVrExchange::DtAppBrokerManager::setBrokerInitLists ( std::vector< DtXMLBrokerLauncher vector)
virtual

If you want the broker manager to re-start brokers, it needs to know how to do that.

virtual DtString MAKVrExchange::DtAppBrokerManager::lookupBrokerName ( const DtU16 &  brokerId) const
virtual

look up a broker name given its ID

virtual DtU16 MAKVrExchange::DtAppBrokerManager::lookupBrokerId ( const DtString brokerName) const
virtual

look up a broker ID given its Name

virtual void MAKVrExchange::DtAppBrokerManager::setOneToOne ( bool  val)
virtual

Set One To One mapping of Broker's initializer so app broker manager has the same settings as the portal.

virtual const QTreeWidget* MAKVrExchange::DtAppBrokerManager::treeWidget ( ) const
virtual

Const accessor for the tree widget.

Used to back up column spacing.

virtual QTreeWidget* MAKVrExchange::DtAppBrokerManager::treeWidget ( )
virtual

Accessor for the tree widget.

Used to restore column spacing.

void MAKVrExchange::DtAppBrokerManager::brokerSelectedRunning ( bool  )
signal
virtual void MAKVrExchange::DtAppBrokerManager::brokerItemEdited ( DtXMLBrokerLauncher )
virtualslot

A new broker has been edited internally.

virtual void MAKVrExchange::DtAppBrokerManager::brokerItemAdded ( DtXMLBrokerLauncher )
virtualslot

A new broker has been added internally.

virtual void MAKVrExchange::DtAppBrokerManager::brokerItemRemoved ( DtXMLBrokerLauncher )
virtualslot

A new broker has been removed internally.

virtual void MAKVrExchange::DtAppBrokerManager::showBrokerInfoDialogAction ( )
virtualslot

Display information on currently selected broker.

virtual void MAKVrExchange::DtAppBrokerManager::brokerShutdownBrokerAction ( )
virtualslot

Shutdown currently selected broker.

virtual void MAKVrExchange::DtAppBrokerManager::brokerRestartBrokerAction ( )
virtualslot

Restart currently selected broker.

virtual void MAKVrExchange::DtAppBrokerManager::brokerRemoveBrokerAction ( )
virtualslot

Remove currently selected broker from the list.

virtual void MAKVrExchange::DtAppBrokerManager::brokerEditBrokerAction ( )
virtualslot

Edit the configuration file.

virtual void MAKVrExchange::DtAppBrokerManager::brokerAddNewBrokerAction ( )
virtualslot

Add a new broker.

virtual void MAKVrExchange::DtAppBrokerManager::brokerItemDoubleClicked ( QTreeWidgetItem item)
protectedvirtualslot

callback for when an broker is double clicked.

virtual void MAKVrExchange::DtAppBrokerManager::brokerItemRightButtonPressed ( QTreeWidgetItem item,
const QPoint &  point 
)
protectedvirtualslot

callback for when an broker is right clicked.

virtual void MAKVrExchange::DtAppBrokerManager::brokerSelectionChanged ( )
protectedvirtualslot

Broker item has changed. Used for color swapping.

virtual void MAKVrExchange::DtAppBrokerManager::processAddBrokerMessage ( const DtBrokerStartedMessage msg)
protectedvirtual

processes an brokerAddMessage by adding the broker name to the broker list

virtual void MAKVrExchange::DtAppBrokerManager::processRemoveBrokerMessage ( const DtBrokerExitingMessage msg)
protectedvirtual

processes an brokerRemove message from the portal by removing the name from the list

virtual void MAKVrExchange::DtAppBrokerManager::processAbnormalRemoval ( const DtAbnormalBrokerExitMessage msg)
protectedvirtual

processes an abnormal removal message and then called processRemoveBrokerMessage

virtual void MAKVrExchange::DtAppBrokerManager::launchBrokerForItem ( QTreeWidgetItem item)
protectedvirtual

launches the broker which is represented by this item

virtual void MAKVrExchange::DtAppBrokerManager::shutdownBrokerForItem ( QTreeWidgetItem item)
protectedvirtual

shutdown the broker which is represented by this item

virtual DtString MAKVrExchange::DtAppBrokerManager::createBrokerStartupCommand ( const DtXMLBrokerLauncher brokerLauncher)
protectedvirtual

creates a base common command line to start a broker

static void MAKVrExchange::DtAppBrokerManager::discoverBrokerCb ( const DtBrokerStartedMessage msg,
void *  usrData 
)
staticprotected

a callback registered with the portal, to be called when a new broker is discovered

static void MAKVrExchange::DtAppBrokerManager::removeBrokerCb ( const DtBrokerExitingMessage msg,
void *  usrData 
)
staticprotected

a callback registered with the portal, to be called when an broker is deleted

static void MAKVrExchange::DtAppBrokerManager::abnormalRemovalCb ( const DtAbnormalBrokerExitMessage msg,
void *  usrData 
)
staticprotected

a callback registered with the portal, to be called when an broker is suspiciously removed

virtual bool MAKVrExchange::DtAppBrokerManager::eventFilter ( QObject obj,
QEvent *  event 
)
protectedvirtual
DtAppBrokerManager& MAKVrExchange::DtAppBrokerManager::operator= ( const DtAppBrokerManager orig)
private

Assignment Operator Not Implemented.

Member Data Documentation

enum { ... } MAKVrExchange::DtAppBrokerManager::BrokerPopupMenuPosition
Ui::DtBrokerList MAKVrExchange::DtAppBrokerManager::myUi
protected
std::vector<DtXMLBrokerLauncher> MAKVrExchange::DtAppBrokerManager::myBrokerLaunchers
protected
QMenu* MAKVrExchange::DtAppBrokerManager::myPopupMenu
protected

A popup menu used for the selected broker.

QMenu* MAKVrExchange::DtAppBrokerManager::myDisabledPopupMenu
protected
QMenu* MAKVrExchange::DtAppBrokerManager::myUnselectedPopupMenu
protected
DtPortalConnection* MAKVrExchange::DtAppBrokerManager::myPConn
protected
DtPortalAppInitializer* MAKVrExchange::DtAppBrokerManager::myInitializer
protected
DtBrokerEditor* MAKVrExchange::DtAppBrokerManager::myBrokerEditor
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)