DtAssistantMgr Class Reference

Base class for all classes which perform management activities for the Assistant. More...

Inheritance diagram for DtAssistantMgr:

Collaboration diagram for DtAssistantMgr:

Public Slots
void	displayWarningDialogs ()
	Displays all warning dialogs.

Signals
void	warningDialogDisplayed ()
	Emitted when a warning dialog is displayed.
void	warningDialogDismissed ()
	Emitted when a warning dialog is dismissed.
void	popupRequested (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	popupRequested (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId, bool logOnly)
	Emitted when a notification should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source, bool logOnly)
	Emitted when a notification should be displayed.

Public Member Functions
	DtAssistantMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
	Constructor.
virtual	~DtAssistantMgr ()
	Destructor.
virtual void	initialize ()
	Initializes this manager just prior to beginning assistant processing.
virtual void	tick ()
	Performs tasks that need to be completed periodically.
virtual void	startShutdown ()
	Performs any necessary processing at the start of shutdown.
virtual bool	dialogsVisible () const
	Determines if there are any visible dialogs for which this manager is responsible.
virtual void	configWidget (DtAssistantConfigWidget **widget, QIcon &icon, QString &name, DtPreferencesPage &pageId)
	Retrieves a widget which will be placed in the configuration dialog for configuring user preferences.
virtual void	updateConfigWidget ()
	Forces the configuration widget to be updated.
virtual void	processConfigWidgetAccept ()
	Process the changes that were accepted in the configuration widget.

Protected Member Functions
void	startDialog (QDialog *dlg, bool inTaskbar, bool warningDialog)
	Sets up the given widget as a dialog.
void	finishDialog (QDialog *dlg)
	Should be called prior to deleting any dialog started with startDialog.
void	showDialog (QDialog *dlg)
	Shows the dialog.
void	startMainWindow (QMainWindow *dlg)
	Sets up a main window dialog.
void	finishMainWindow (QMainWindow *dlg)
	Should be called prior to deleting any dialog started with startMainWindow.
void	showMainWindow (QMainWindow *dlg)
	Shows the dialog.
void	showPopup (const MAKRti::DtString &text, int sourceCompId=-1, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and name of the given source component.
void	showPopup (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and source name.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Displays and logs a notification from the given component.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Displays and logs notification with the given component name.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Logs a notification from the given component, does not display.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Logs a notification with the given component name, does not display.
virtual DtAssistantInfo	assistantInfoFromAssistantMsg (const DtAssistantMsg &assistantMsg, DtInetAddrSet *interfaces=0)

Protected Attributes
DtBoost::shared_ptr < DtRtiAssistantServer >	myServer
	The Assistant server from which new messages will arrive from local RTI components.
DtBoost::shared_ptr < DtRtiAssistantPeer >	myPeer
	The Assistant peer which communicates with other Assistants.
std::set< QDialog * >	myUnparentedDialogs
	All unparented dialogs that are created by the GUI should be added to this set.
std::set< QMainWindow * >	myMainWindows
	All main windows that are created by the GUI should be added to this set.
std::set< QDialog * >	myWarningDialogs
	Set of the popup dialogs, either parented or unparented, which, when active, should cause a warning icon to be displayed.

Static Protected Attributes
static QIcon	theRtiIcon
	The icons used by the RTI Assistant.
static QIcon	theSmallRtiIcon
static QIcon	theWebIcon
static QIcon	theNotifyRtiIcon
static QIcon	theWarningRtiIcon
static QIcon	thePreferencesIcon
static QIcon	theAboutIcon
static QIcon	theHelpIcon
static bool	theIconsAreLoaded
	Whether or not the icons have yet been loaded.

Private Member Functions
	DtAssistantMgr (DtAssistantMgr const &)
	Copy Constructor not implemented – Copy Not Allowed!
DtAssistantMgr &	operator= (DtAssistantMgr const &)
	Assignment not implemented – Assignment Not Allowed!

Detailed Description

Base class for all classes which perform management activities for the Assistant.

Derived from the QObject class in order to receive Qt signals.

Constructor & Destructor Documentation

DtAssistantMgr::DtAssistantMgr	(	DtBoost::shared_ptr< DtRtiAssistantServer >	server,
		DtBoost::shared_ptr< DtRtiAssistantPeer >	peer,
		DtAssistantSignalRouter &	signalRouter
	)

Constructor.

virtual DtAssistantMgr::~DtAssistantMgr ( )

virtual

Destructor.

DtAssistantMgr::DtAssistantMgr ( DtAssistantMgr const &  )

private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

virtual DtAssistantInfo DtAssistantMgr::assistantInfoFromAssistantMsg ( const DtAssistantMsg &  assistantMsg, DtInetAddrSet *  interfaces = 0  )

protectedvirtual

virtual void DtAssistantMgr::configWidget ( DtAssistantConfigWidget **  widget, QIcon &  icon, QString &  name, DtPreferencesPage &  pageId  )

inlinevirtual

Retrieves a widget which will be placed in the configuration dialog for configuring user preferences.

Reimplemented in DtAssistantLicenseQueryMgr, and DtAssistantConnQueryMgr.

virtual bool DtAssistantMgr::dialogsVisible ( ) const

virtual

Determines if there are any visible dialogs for which this manager is responsible.

If possible, derived manager classes should call startDialog on all dialogs. Otherwise it should should override this method to take those into account as well.

Reimplemented in DtAssistantFederationsViewMgr.

void DtAssistantMgr::displayNotification ( const MAKRti::DtString &  message, MAKRti::DtNotifyLevelType  notifyLevel, int  sourceCompId = -1  )

protected

Displays and logs a notification from the given component.

A source of -1 is the Assistant.

void DtAssistantMgr::displayNotification ( const MAKRti::DtString &  message, MAKRti::DtNotifyLevelType  notifyLevel, const MAKRti::DtString &  source  )

protected

Displays and logs notification with the given component name.

void DtAssistantMgr::displayWarningDialogs ( )

slot

Displays all warning dialogs.

void DtAssistantMgr::finishDialog ( QDialog *  dlg )

protected

Should be called prior to deleting any dialog started with startDialog.

void DtAssistantMgr::finishMainWindow ( QMainWindow *  dlg )

protected

Should be called prior to deleting any dialog started with startMainWindow.

virtual void DtAssistantMgr::initialize ( )

inlinevirtual

Initializes this manager just prior to beginning assistant processing.

Reimplemented in DtAssistantRidConfigInfoMgr, DtAssistantConnectionInfoMgr, DtAssistantPreferencesInfoMgr, DtAssistantPreferencesViewMgr, DtRemoteAssistantInfoMgr, DtRidConfigViewMgr, and DtRemoteAssistantViewMgr.

void DtAssistantMgr::logNotification ( const MAKRti::DtString &  message, MAKRti::DtNotifyLevelType  notifyLevel, int  sourceCompId = -1  )

protected

Logs a notification from the given component, does not display.

A source of -1 is the Assistant.

void DtAssistantMgr::logNotification ( const MAKRti::DtString &  message, MAKRti::DtNotifyLevelType  notifyLevel, const MAKRti::DtString &  source  )

protected

Logs a notification with the given component name, does not display.

void DtAssistantMgr::notificationRequested ( const MAKRti::DtString &  message, MAKRti::DtNotifyLevelType  notifyLevel, int  sourceCompId, bool  logOnly  )

signal

Emitted when a notification should be displayed.

void DtAssistantMgr::notificationRequested ( const MAKRti::DtString &  message, MAKRti::DtNotifyLevelType  notifyLevel, const MAKRti::DtString &  source, bool  logOnly  )

signal

Emitted when a notification should be displayed.

DtAssistantMgr& DtAssistantMgr::operator= ( DtAssistantMgr const &  )

private

Assignment not implemented – Assignment Not Allowed!

void DtAssistantMgr::popupRequested ( const MAKRti::DtString &  text, int  sourceCompId, const MAKRti::DtString &  advancedText  )

signal

Emitted when a popup dialog should be displayed.

void DtAssistantMgr::popupRequested ( const MAKRti::DtString &  text, const MAKRti::DtString &  source, const MAKRti::DtString &  advancedText  )

signal

Emitted when a popup dialog should be displayed.

virtual void DtAssistantMgr::processConfigWidgetAccept ( )

inlinevirtual

Process the changes that were accepted in the configuration widget.

Reimplemented in DtAssistantConnQueryMgr, and DtRidConfigViewMgr.

void DtAssistantMgr::showDialog ( QDialog *  dlg )

protected

Shows the dialog.

Should be used instead of the show method for any dialogs started with startDialog.

void DtAssistantMgr::showMainWindow ( QMainWindow *  dlg )

protected

Shows the dialog.

Should be used instead of the show method for any dialogs started with startDialog.

void DtAssistantMgr::showPopup ( const MAKRti::DtString &  text, int  sourceCompId = -1, const MAKRti::DtString &  advancedText = MAKRti::DtString::nullString()  )

protected

Displays a popup message with the given text, advanced text, and name of the given source component.

A source of -1 is the Assistant.

void DtAssistantMgr::showPopup ( const MAKRti::DtString &  text, const MAKRti::DtString &  source, const MAKRti::DtString &  advancedText = MAKRti::DtString::nullString()  )

protected

Displays a popup message with the given text, advanced text, and source name.

void DtAssistantMgr::startDialog ( QDialog *  dlg, bool  inTaskbar, bool  warningDialog  )

protected

Sets up the given widget as a dialog.

This method should be called for all dialogs created by this class in order to make sure they are initialized and kept track of correctly. Can specify whether the dialog will have a task bar entry and whether it will result in a warning icon in the tray when displayed.

void DtAssistantMgr::startMainWindow ( QMainWindow *  dlg )

protected

Sets up a main window dialog.

This method should be called for all main windows created by this class in order to make sure they are initialized and kept track of correctly. All main windows will appear in the task bar and will not be considered warning dialogs.

virtual void DtAssistantMgr::startShutdown ( )

inlinevirtual

Performs any necessary processing at the start of shutdown.

Reimplemented in DtAssistantConnectionInfoMgr, DtAssistantFederationsViewMgr, DtAssistantPreferencesInfoMgr, DtAssistantTrayIconMgr, DtAssistantFederateViewMgr, and DtAssistantFomViewMgr.

virtual void DtAssistantMgr::tick ( )

inlinevirtual

Performs tasks that need to be completed periodically.

Reimplemented in DtAssistantFederationsInfoMgr, DtAssistantConnectionInfoMgr, DtAssistantFederationsViewMgr, DtAssistantPreferencesViewMgr, DtAssistantForwarderCompInfoMgr, DtAssistantLicenseQueryMgr, DtAssistantPopupMsgMgr, DtAssistantConnQueryMgr, DtRemoteAssistantInfoMgr, and DtRemoteAssistantViewMgr.

virtual void DtAssistantMgr::updateConfigWidget ( )

inlinevirtual

Forces the configuration widget to be updated.

Reimplemented in DtAssistantLicenseQueryMgr, and DtAssistantConnQueryMgr.

void DtAssistantMgr::warningDialogDismissed ( )

signal

Emitted when a warning dialog is dismissed.

void DtAssistantMgr::warningDialogDisplayed ( )

signal

Emitted when a warning dialog is displayed.

Member Data Documentation

std::set<QMainWindow *> DtAssistantMgr::myMainWindows

protected

All main windows that are created by the GUI should be added to this set.

DtBoost::shared_ptr<DtRtiAssistantPeer> DtAssistantMgr::myPeer

protected

The Assistant peer which communicates with other Assistants.

DtBoost::shared_ptr<DtRtiAssistantServer> DtAssistantMgr::myServer

protected

The Assistant server from which new messages will arrive from local RTI components.

std::set<QDialog *> DtAssistantMgr::myUnparentedDialogs

protected

All unparented dialogs that are created by the GUI should be added to this set.

std::set<QDialog*> DtAssistantMgr::myWarningDialogs

protected

Set of the popup dialogs, either parented or unparented, which, when active, should cause a warning icon to be displayed.

QIcon DtAssistantMgr::theAboutIcon

staticprotected

QIcon DtAssistantMgr::theHelpIcon

staticprotected

bool DtAssistantMgr::theIconsAreLoaded

staticprotected

Whether or not the icons have yet been loaded.

QIcon DtAssistantMgr::theNotifyRtiIcon

staticprotected

QIcon DtAssistantMgr::thePreferencesIcon

staticprotected

QIcon DtAssistantMgr::theRtiIcon

staticprotected

The icons used by the RTI Assistant.

QIcon DtAssistantMgr::theSmallRtiIcon

staticprotected

QIcon DtAssistantMgr::theWarningRtiIcon

staticprotected

QIcon DtAssistantMgr::theWebIcon

staticprotected

---

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

• assistantMgr.h