MAKVrExchange::DtAppBrokerManager Class Reference

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

Inheritance diagram for MAKVrExchange::DtAppBrokerManager:

Public Types
enum	{ DisplayInformation, Shutdown }

Public Slots
virtual void	brokerItemAdded (DtXmlBrokerLauncher &)
	A new broker has been added internally. More...
virtual void	brokerItemEdited (DtXmlBrokerLauncher &)
	A new broker has been edited internally. More...
virtual void	showBrokerInfoDialogAction ()
	Display information on currently selected broker. More...
virtual void	brokerShutdownBrokerAction ()
	Shutdown currently selected broker. More...
virtual void	brokerRestartBrokerAction ()
	Restart currently selected broker. More...
virtual void	brokerRemoveBrokerAction ()
	Remove currently selected broker from the list. More...
virtual void	brokerEditBrokerAction ()
	Edit the configuration file. More...
virtual void	brokerAddNewBrokerAction ()
	Add a new broker. More...
virtual void	setDarkModeEnabled (bool enable)
	Set styling for the broker. More...
virtual bool	darkModeEnabled ()
	Access styling setting for broker. More...

Signals
void	brokerSelectedRunning (bool)

Public Member Functions
	DtAppBrokerManager (QWidget *parent, DtPortalAppInitializer *init, DtPortalConnection *pconn)
virtual	~DtAppBrokerManager ()
	Destructor. More...
virtual void	setBrokerInitLists (const std::vector< DtXmlBrokerLauncher > &vector)
	If you want the broker manager to re-start brokers, it needs to know how to do that. More...
virtual DtString	lookupBrokerName (const DtU16 &brokerId) const
	look up a broker name given its ID More...
virtual DtU16	lookupBrokerId (const DtString &brokerName) const
	look up a broker ID given its Name More...
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. More...
virtual const QTreeWidget *	treeWidget () const
	Const accessor for the tree widget. More...
virtual QTreeWidget *	treeWidget ()
	Accessor for the tree widget. More...

Protected Types
enum	{ ShutdownBroker = 1 }
typedef std::map< DtU16, DtString >	BrokerIdToNameMap

Protected Slots
virtual void	brokerItemDoubleClicked (QTreeWidgetItem *item)
	callback for when an broker is double clicked. More...
virtual void	brokerSelectionChanged ()
	Broker item has changed. Used for color swapping. More...
virtual void	onBrokerMenuAboutToShow ()
	Update the broker context menu on show. More...

Protected Member Functions
virtual void	processAddBrokerMessage (const DtBrokerStartedMessage &msg)
	Processes DtBrokerStartedMessage by adding the broker name to the broker list. More...
virtual void	processRunBrokerMessage (const DtBrokerRunningMessage &msg)
	Processes DtBrokerRunningMessage by adding the broker name to the broker list. More...
virtual void	processRemoveBrokerMessage (const DtBrokerExitingMessage &msg)
	Processes DtBrokerExitingMessage by removing the name from the broker list. More...
virtual void	processAbnormalRemoval (const DtAbnormalBrokerExitMessage &msg)
	Processes DtAbnormalBrokerExitMessage and calls processRemoveBrokerMessage. More...
virtual void	requestBrokerLaunchGui (QTreeWidgetItem *item)
	Sends a 'Launch GUI' request to the broker which is represented by this item. More...
virtual void	requestBrokerStart (QTreeWidgetItem *item)
	Sends a 'Start Broker' request to the broker which is represented by this item. More...
virtual void	shutdownBrokerForItem (QTreeWidgetItem *item)
	shutdown the broker which is represented by this item More...
virtual DtString	createBrokerStartupCommand (const DtXmlBrokerLauncher &brokerLauncher)
	Creates a base common command line to start a broker. More...
virtual bool	eventFilter (QObject *obj, QEvent *event)

Static Protected Member Functions
static void	discoverBrokerCb (const DtBrokerStartedMessage &msg, void *usrData)
	Callback registered with the portal, to be called when a new broker is discovered. More...
static void	runningBrokerCb (const DtBrokerRunningMessage &msg, void *usrData)
	Callback registered with the portal, to be called when a broker is started. More...
static void	removeBrokerCb (const DtBrokerExitingMessage &msg, void *usrData)
	Callback registered with the portal, to be called when an broker is deleted. More...
static void	abnormalRemovalCb (const DtAbnormalBrokerExitMessage &msg, void *usrData)
	Callback registered with the portal, to be called when an broker is suspiciously removed. More...

Protected Attributes
enum MAKVrExchange::DtAppBrokerManager:: { ... }	BrokerPopupMenuPosition
Ui::DtBrokerList	myUi
std::vector< DtXmlBrokerLauncher >	myBrokerLaunchers
DtBrokerContextMenu *	myPopupMenu
	A popup menu used for the selected broker. More...
DtPortalConnection *	myPConn
DtPortalAppInitializer *	myInitializer
DtBrokerEditor *	myBrokerEditor
bool	myDarkModeEnabled

Private Member Functions
	DtAppBrokerManager (const DtAppBrokerManager &orig)
	Copy Ctor Not Implemented. More...
DtAppBrokerManager &	operator= (const DtAppBrokerManager &orig)
	Assignment Operator Not Implemented. More...

Private Attributes
QColor	myDisconColor
QColor	myConColor
bool	first = true

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

typedef std::map<DtU16,DtString> MAKVrExchange::DtAppBrokerManager::BrokerIdToNameMap

protected

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

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

staticprotected

Callback registered with the portal, to be called when an broker is suspiciously removed.

virtual void MAKVrExchange::DtAppBrokerManager::brokerAddNewBrokerAction ( )

virtualslot

Add a new broker.

virtual void MAKVrExchange::DtAppBrokerManager::brokerEditBrokerAction ( )

virtualslot

Edit the configuration file.

virtual void MAKVrExchange::DtAppBrokerManager::brokerItemAdded ( DtXmlBrokerLauncher &  )

virtualslot

A new broker has been added internally.

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

protectedvirtualslot

callback for when an broker is double clicked.

virtual void MAKVrExchange::DtAppBrokerManager::brokerItemEdited ( DtXmlBrokerLauncher &  )

virtualslot

A new broker has been edited internally.

virtual void MAKVrExchange::DtAppBrokerManager::brokerRemoveBrokerAction ( )

virtualslot

Remove currently selected broker from the list.

virtual void MAKVrExchange::DtAppBrokerManager::brokerRestartBrokerAction ( )

virtualslot

Restart currently selected broker.

void MAKVrExchange::DtAppBrokerManager::brokerSelectedRunning ( bool  )

signal

virtual void MAKVrExchange::DtAppBrokerManager::brokerSelectionChanged ( )

protectedvirtualslot

Broker item has changed. Used for color swapping.

virtual void MAKVrExchange::DtAppBrokerManager::brokerShutdownBrokerAction ( )

virtualslot

Shutdown currently selected broker.

virtual DtString MAKVrExchange::DtAppBrokerManager::createBrokerStartupCommand ( const DtXmlBrokerLauncher &  brokerLauncher )

protectedvirtual

Creates a base common command line to start a broker.

virtual bool MAKVrExchange::DtAppBrokerManager::darkModeEnabled ( )

virtualslot

Access styling setting for broker.

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

staticprotected

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

virtual bool MAKVrExchange::DtAppBrokerManager::eventFilter ( QObject *  obj, QEvent *  event  )

protectedvirtual

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

virtual

look up a broker ID given its Name

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

virtual

look up a broker name given its ID

virtual void MAKVrExchange::DtAppBrokerManager::onBrokerMenuAboutToShow ( )

protectedvirtualslot

Update the broker context menu on show.

DtAppBrokerManager& MAKVrExchange::DtAppBrokerManager::operator= ( const DtAppBrokerManager &  orig )

private

Assignment Operator Not Implemented.

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

protectedvirtual

Processes DtAbnormalBrokerExitMessage and calls processRemoveBrokerMessage.

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

protectedvirtual

Processes DtBrokerStartedMessage by adding the broker name to the broker list.

The status of the broker will be set to 'Configuring'.

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

protectedvirtual

Processes DtBrokerExitingMessage by removing the name from the broker list.

The status of the broker will be set to 'Disconnected'.

virtual void MAKVrExchange::DtAppBrokerManager::processRunBrokerMessage ( const DtBrokerRunningMessage &  msg )

protectedvirtual

Processes DtBrokerRunningMessage by adding the broker name to the broker list.

The status of the broker will be set to 'Connected'.

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

staticprotected

Callback registered with the portal, to be called when an broker is deleted.

virtual void MAKVrExchange::DtAppBrokerManager::requestBrokerLaunchGui ( QTreeWidgetItem *  item )

protectedvirtual

Sends a 'Launch GUI' request to the broker which is represented by this item.

virtual void MAKVrExchange::DtAppBrokerManager::requestBrokerStart ( QTreeWidgetItem *  item )

protectedvirtual

Sends a 'Start Broker' request to the broker which is represented by this item.

static void MAKVrExchange::DtAppBrokerManager::runningBrokerCb ( const DtBrokerRunningMessage &  msg, void *  usrData  )

staticprotected

Callback registered with the portal, to be called when a broker is started.

virtual void MAKVrExchange::DtAppBrokerManager::setBrokerInitLists ( const std::vector< DtXmlBrokerLauncher > &  vector )

virtual

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

virtual void MAKVrExchange::DtAppBrokerManager::setDarkModeEnabled ( bool  enable )

virtualslot

Set styling for the broker.

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 void MAKVrExchange::DtAppBrokerManager::showBrokerInfoDialogAction ( )

virtualslot

Display information on currently selected broker.

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

protectedvirtual

shutdown the broker which is represented by this item

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.

Member Data Documentation

enum { ... } MAKVrExchange::DtAppBrokerManager::BrokerPopupMenuPosition

bool MAKVrExchange::DtAppBrokerManager::first = true

private

DtBrokerEditor* MAKVrExchange::DtAppBrokerManager::myBrokerEditor

protected

std::vector<DtXmlBrokerLauncher> MAKVrExchange::DtAppBrokerManager::myBrokerLaunchers

protected

QColor MAKVrExchange::DtAppBrokerManager::myConColor

private

bool MAKVrExchange::DtAppBrokerManager::myDarkModeEnabled

protected

QColor MAKVrExchange::DtAppBrokerManager::myDisconColor

private

DtPortalAppInitializer* MAKVrExchange::DtAppBrokerManager::myInitializer

protected

DtPortalConnection* MAKVrExchange::DtAppBrokerManager::myPConn

protected

DtBrokerContextMenu* MAKVrExchange::DtAppBrokerManager::myPopupMenu

protected

A popup menu used for the selected broker.

Ui::DtBrokerList MAKVrExchange::DtAppBrokerManager::myUi

protected

---

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

• appBrokerManager.h