An abstract version of a Broker Interface. More...

Inheritance diagram for MAKVrExchange::DtGenericUserInterface:

Public Member Functions
	DtGenericUserInterface ()
	Constructor. More...

virtual	~DtGenericUserInterface ()
	Destructor. More...

Broker Dialog Interface
virtual void	brokerStarted ()=0
	Called when the broker starts. More...

virtual void	brokerStopped ()=0
	Called when the broker stops. More...

virtual void	show ()=0
	Called when a request has been made to display the UI. More...

virtual void	showConfigurationOnly ()
	Called when a request has been made to display the UI. More...

virtual void	objectDiscovered (const DtBrokerObject *brokerObject)=0
	Function called when an object is discovered. More...

virtual void	objectUpdated (const DtBrokerObject *brokerObject)=0
	Function called when an object is updated. More...

virtual void	objectRemoved (const DtBrokerObject *brokerObject)=0
	Function called when an object is removed. More...

virtual void	addTranslator (const char *name, bool reflectStatus, bool publishStatus, bool debugging)=0
	Called when a translator is added. More...

virtual void	deleteTranslator (const char *name)=0
	Called when a translator is removed. More...

virtual void	updateTranslator (const char *name, bool reflectStatus, bool publishStatus, bool debugging)=0
	Called when a translator's information has changed. More...

virtual void	revertSettings ()=0
	Refreshes the GUI with the saved settings. More...

virtual void	clientsUpdated ()
	Notifies that the number of clients being served has changed This is only used in client-based brokers such as WebLVC. More...

Private Member Functions
	DtGenericUserInterface (const DtGenericUserInterface &other)
	Copy constructor not implemented - cannot be copied. More...

DtGenericUserInterface &	operator= (const DtGenericUserInterface &other)
	Assignment operator not implemented - cannot be copied. More...

Detailed Description

An abstract version of a Broker Interface.

Constructor & Destructor Documentation

MAKVrExchange::DtGenericUserInterface::DtGenericUserInterface ( )

inline

Constructor.

virtual MAKVrExchange::DtGenericUserInterface::~DtGenericUserInterface ( )

inlinevirtual

Destructor.

MAKVrExchange::DtGenericUserInterface::DtGenericUserInterface ( const DtGenericUserInterface & other )

private

Copy constructor not implemented - cannot be copied.

Member Function Documentation

virtual void MAKVrExchange::DtGenericUserInterface::addTranslator	(	const char *	name,
		bool	reflectStatus,
		bool	publishStatus,
		bool	debugging
	)

pure virtual

Called when a translator is added.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::brokerStarted ( )

pure virtual

Called when the broker starts.

Depending on the type of UI, this may be a no-op. UIs who need to be updated when the broker starts can do that here.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::brokerStopped ( )

pure virtual

Called when the broker stops.

Depending on the type of UI, this may be a no-op. UIs who need to be updated when the broker stops can do that here.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::clientsUpdated ( )

inlinevirtual

Notifies that the number of clients being served has changed This is only used in client-based brokers such as WebLVC.

Reimplemented in MAKVrExchange::DtQtUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::deleteTranslator ( const char * name )

pure virtual

Called when a translator is removed.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::objectDiscovered ( const DtBrokerObject * brokerObject )

pure virtual

Function called when an object is discovered.

Parameters

[in] brokerObject The object discovered.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::objectRemoved ( const DtBrokerObject * brokerObject )

pure virtual

Function called when an object is removed.

Parameters

[in] brokerObject The object removed.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::objectUpdated ( const DtBrokerObject * brokerObject )

pure virtual

Function called when an object is updated.

Parameters

[in] brokerObject The object updated.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

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

private

Assignment operator not implemented - cannot be copied.

virtual void MAKVrExchange::DtGenericUserInterface::revertSettings ( )

pure virtual

Refreshes the GUI with the saved settings.

Implemented in MAKVrExchange::DtQtUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::show ( )

pure virtual

Called when a request has been made to display the UI.

Depending on the type of UI, this may be a no-op. Shows all parts of the interface.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::showConfigurationOnly ( )

inlinevirtual

Called when a request has been made to display the UI.

Depending on the type of UI, this may be a no-op. Only shows the configuration relevant of the interface.

Reimplemented in MAKVrExchange::DtQtUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::updateTranslator	(	const char *	name,
		bool	reflectStatus,
		bool	publishStatus,
		bool	debugging
	)

pure virtual

Called when a translator's information has changed.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

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

genericUserInterface.h

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation