MAK RTIspy API Documentation for HLA Evolved
Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions

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

+ Inheritance diagram for DtAssistantMgr:
+ Collaboration diagram for DtAssistantMgr:

List of all members.

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)
 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)
 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 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.

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 widgets 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 theWebIcon
static QIcon theNotifyRtiIcon
static QIcon theWarningRtiIcon
static QIcon thePreferencesIcon
static QIcon theAboutIcon
static QIcon theHelpIcon
static bool theIconsAreLoaded = false
 Whether or not the icons have yet been loaded.

Private Member Functions

 DtAssistantMgr (DtAssistantMgr const &)
 Copy Constructor not implemented -- Copy Not Allowed!
DtAssistantMgroperator= (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 
)

Destructor.

References myUnparentedDialogs.

Copy Constructor not implemented -- Copy Not Allowed!


Member Function Documentation

virtual void DtAssistantMgr::configWidget ( DtAssistantConfigWidget **  widget,
QIcon &  icon,
QString &  name 
) [inline, virtual]

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

Reimplemented in DtAssistantConnQueryMgr, and DtAssistantLicenseQueryMgr.

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 DtAssistantNetworkCompViewMgr, and DtAssistantFederationsViewMgr.

References myUnparentedDialogs.

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.

References notificationRequested().

Referenced by DtAssistantPopupMsgMgr::addPopupMsgToQueue(), DtAssistantPopupMsgMgr::popup(), DtAssistantComponentMgr::processSocketRemoval(), and DtAssistantFederationsInfoMgr::tick().

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

Displays and logs notification with the given component name.

References notificationRequested().

Displays all warning dialogs.

References myWarningDialogs, and showDialog().

void DtAssistantMgr::finishDialog ( QDialog dlg) [protected]
virtual void DtAssistantMgr::initialize ( ) [inline, virtual]

Initializes this manager just prior to beginning assistant processing.

Reimplemented in DtAssistantPreferencesViewMgr.

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.

References notificationRequested().

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.

References notificationRequested().

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

Emitted when a notification should be displayed.

Referenced by displayNotification(), and logNotification().

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.

Referenced by showPopup().

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 ( ) [inline, virtual]

Process the changes that were accepted in the configuration widget.

Reimplemented in DtAssistantConnQueryMgr.

void DtAssistantMgr::showDialog ( QDialog dlg) [protected]
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.

References popupRequested().

Referenced by DtAssistantFederationsInfoMgr::processRemoteRtiexecPopupMsg().

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.

Reimplemented in DtAssistantNetworkCompViewMgr.

References popupRequested().

void DtAssistantMgr::startDialog ( QDialog dlg,
bool  inTaskbar,
bool  warningDialog 
) [protected]
virtual void DtAssistantMgr::startShutdown ( ) [inline, virtual]

Performs any necessary processing at the start of shutdown.

Reimplemented in DtAssistantNetworkCompViewMgr, DtAssistantFederationsViewMgr, DtAssistantTrayIconMgr, DtAssistantConnectionInfoMgr, and DtAssistantPreferencesInfoMgr.

virtual void DtAssistantMgr::tick ( ) [inline, virtual]
virtual void DtAssistantMgr::updateConfigWidget ( ) [inline, virtual]

Forces the configuration widget to be updated.

Reimplemented in DtAssistantConnQueryMgr, and DtAssistantLicenseQueryMgr.

Emitted when a warning dialog is dismissed.

Referenced by startDialog().

Emitted when a warning dialog is displayed.

Referenced by showDialog().


Member Data Documentation

DtBoost::shared_ptr<DtRtiAssistantPeer> DtAssistantMgr::myPeer [protected]

The Assistant peer which communicates with other Assistants.

Referenced by DtAssistantFederationsViewMgr::destroyFederation(), DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr(), DtAssistantConnQueryMgr::DtAssistantConnQueryMgr(), DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), DtAssistantFederationsViewMgr::DtAssistantFederationsViewMgr(), DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr(), DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr(), DtAssistantNetworkCompInfoMgr::DtAssistantNetworkCompInfoMgr(), DtAssistantNetworkCompViewMgr::DtAssistantNetworkCompViewMgr(), DtAssistantTrayIconMgr::DtAssistantTrayIconMgr(), DtAssistantFederationsInfoMgr::forwardMsgFromLocalRtiexec(), DtAssistantLatencyTestMgr::getRtiexecConn(), DtAssistantConnectionInfoMgr::heartbeatAssistant(), DtAssistantConnectionInfoMgr::heartbeatLightweightConnections(), DtAssistantNetworkCompViewMgr::processExecObserveRspMsg(), DtAssistantFederationsInfoMgr::processExecObserveRspMsg(), DtAssistantFederationsInfoMgr::processFederationStateMsg(), DtAssistantNetworkCompInfoMgr::processForwarderObserveMsg(), DtAssistantNetworkCompInfoMgr::processForwarderStateMsgForConnection(), DtAssistantConnectionInfoMgr::processInfoMsg(), DtAssistantLatencyTestMgr::processLatencyTestResults(), DtAssistantConnectionInfoMgr::processLightweightInfoMsg(), DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected(), DtAssistantTrayIconMgr::processNotifyObserveMsg(), DtAssistantFederationsInfoMgr::processObserveMsg(), DtAssistantFederationsInfoMgr::processRemoteRtiexecPopupMsg(), DtAssistantConnectionInfoMgr::processRemovalMsg(), DtAssistantFederationsViewMgr::processRidParamMsg(), DtAssistantNetworkCompViewMgr::processRtiexecLogMsg(), DtAssistantNetworkCompViewMgr::processRtiexecNotifyMsg(), DtAssistantFederationsInfoMgr::processSyncPtStateMsg(), DtAssistantLatencyTestMgr::processTestCommand(), DtAssistantFederationsViewMgr::resignFederate(), DtAssistantFederationsInfoMgr::sendAllFederationInfo(), DtAssistantNetworkCompInfoMgr::sendAllForwarderInfo(), DtAssistantLatencyTestMgr::sendLatencyTestCommand(), DtAssistantLicenseQueryMgr::sendLicenseServerUpdate(), DtAssistantNetworkCompViewMgr::sendLogRequest(), DtAssistantFederationsViewMgr::sendNetworkTestingDisableMsg(), DtAssistantFederationsViewMgr::sendNetworkTestingEnableMsg(), DtAssistantTrayIconMgr::sendNotifyObserveMsg(), DtAssistantFederationsInfoMgr::sendObserveFederationsMsg(), DtAssistantNetworkCompInfoMgr::sendObserveForwarderMsg(), DtAssistantFederationsViewMgr::sendRidParamRequest(), DtAssistantPreferencesViewMgr::showConfigDialog(), DtAssistantPreferencesViewMgr::showMsgStats(), DtAssistantNetworkCompViewMgr::shutdownRtiexec(), DtAssistantNetworkCompViewMgr::shutdownRtiForwarder(), DtAssistantFederationsInfoMgr::startRtiexec(), DtAssistantFederationsInfoMgr::viewFederationsForConnection(), DtAssistantNetworkCompInfoMgr::viewNetworkComponentsForConnection(), DtAssistantConnectionInfoMgr::~DtAssistantConnectionInfoMgr(), DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr(), DtAssistantFederationsViewMgr::~DtAssistantFederationsViewMgr(), DtAssistantLatencyTestMgr::~DtAssistantLatencyTestMgr(), DtAssistantLicenseQueryMgr::~DtAssistantLicenseQueryMgr(), DtAssistantNetworkCompInfoMgr::~DtAssistantNetworkCompInfoMgr(), and DtAssistantNetworkCompViewMgr::~DtAssistantNetworkCompViewMgr().

DtBoost::shared_ptr<DtRtiAssistantServer> DtAssistantMgr::myServer [protected]

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

Referenced by DtAssistantConnQueryMgr::addConnQueryMsgToQueue(), DtAssistantLicenseQueryMgr::addLicQueryMsgToQueue(), DtAssistantPopupMsgMgr::addPopupMsgToQueue(), DtAssistantNetworkCompViewMgr::changeViewedRtiForwarder(), DtAssistantFederationsViewMgr::destroyFederation(), DtAssistantComponentMgr::DtAssistantComponentMgr(), DtAssistantConnQueryMgr::DtAssistantConnQueryMgr(), DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), DtAssistantFederationsViewMgr::DtAssistantFederationsViewMgr(), DtAssistantLatencyTestMgr::DtAssistantLatencyTestMgr(), DtAssistantLicenseQueryMgr::DtAssistantLicenseQueryMgr(), DtAssistantNetworkCompInfoMgr::DtAssistantNetworkCompInfoMgr(), DtAssistantNetworkCompViewMgr::DtAssistantNetworkCompViewMgr(), DtAssistantPopupMsgMgr::DtAssistantPopupMsgMgr(), DtAssistantTrayIconMgr::DtAssistantTrayIconMgr(), DtAssistantNetworkCompInfoMgr::federateRemovalTimeChanged(), DtAssistantFederationsInfoMgr::forwardMsgFromLocalRtiexec(), DtAssistantFederationsInfoMgr::forwardMsgToLocalRtiexec(), DtAssistantLatencyTestMgr::getRtiexecConn(), DtAssistantNetworkCompInfoMgr::handleRtiCommands(), DtAssistantNetworkCompInfoMgr::processAssistantCommandMsg(), DtAssistantFederationsInfoMgr::processAssistantCommandMsg(), DtAssistantNetworkCompViewMgr::processAwaitingForwardersMsg(), DtAssistantComponentMgr::processCloseConnMsg(), DtAssistantConnQueryMgr::processConnQueryMsg(), DtAssistantConnQueryMgr::processConnQueryResults(), DtAssistantNetworkCompViewMgr::processDoNotWaitForForwarders(), DtAssistantFederationsInfoMgr::processExecStateMsgForConnection(), DtAssistantFederationsInfoMgr::processFederateStateMsg(), DtAssistantFederationsInfoMgr::processFederationStateMsg(), DtAssistantNetworkCompInfoMgr::processForwarderObserveMsg(), DtAssistantNetworkCompInfoMgr::processForwarderStateMsgForConnection(), DtAssistantLatencyTestMgr::processLatencyTestResults(), DtAssistantLicenseQueryMgr::processLicQueryMsg(), DtAssistantLicenseQueryMgr::processLicQueryResults(), DtAssistantFederationsInfoMgr::processLocalFederateJoined(), DtAssistantComponentMgr::processLrcCompInfoMsg(), DtAssistantComponentMgr::processNewConnMsg(), DtAssistantTrayIconMgr::processNotifyMsg(), DtAssistantFederationsInfoMgr::processObserveMsg(), DtAssistantFederationsViewMgr::processRidParamMsg(), DtAssistantComponentMgr::processRtiexecCompInfoMsg(), DtAssistantNetworkCompViewMgr::processRtiexecLogMsg(), DtAssistantNetworkCompViewMgr::processRtiexecNotifyMsg(), DtAssistantComponentMgr::processRtiForwarderCompInfoMsg(), DtAssistantTrayIconMgr::processShowDialogMsg(), DtAssistantNetworkCompViewMgr::processShutDownWaitingForwarder(), DtAssistantFederationsInfoMgr::processSignalTickedMsg(), DtAssistantFederationsInfoMgr::processSyncPtStateMsg(), DtAssistantLatencyTestMgr::processTestCommand(), DtAssistantLatencyTestMgr::processTestMgrStatusUpdate(), DtAssistantFederationsInfoMgr::processTimeStateMsg(), DtAssistantComponentMgr::processWwwCompInfoMsg(), DtAssistantFederationsInfoMgr::pruneStaleFederationsAndObservers(), DtAssistantFederationsInfoMgr::pruneTimedOutSingleUpdates(), DtAssistantNetworkCompInfoMgr::pruneTimedOutSingleUpdates(), DtAssistantNetworkCompInfoMgr::requestSingleUpdateFromConnectedForwarders(), DtAssistantFederationsInfoMgr::requestSingleUpdateFromConnectedRtiexecs(), DtAssistantFederationsViewMgr::resignFederate(), DtAssistantTrayIconMgr::sendComponentEnableLogging(), DtAssistantTrayIconMgr::sendComponentExit(), DtAssistantTrayIconMgr::sendComponentUpdateNotifyLevel(), DtAssistantLatencyTestMgr::sendLatencyTestCommand(), DtAssistantNetworkCompViewMgr::sendLogRequest(), DtAssistantFederationsViewMgr::sendNetworkTestingDisableMsg(), DtAssistantFederationsViewMgr::sendNetworkTestingEnableMsg(), DtAssistantFederationsViewMgr::sendRidParamRequest(), DtAssistantPreferencesViewMgr::showConfigDialog(), DtAssistantNetworkCompViewMgr::shutdownRtiexec(), DtAssistantNetworkCompViewMgr::shutdownRtiForwarder(), DtAssistantNetworkCompInfoMgr::tick(), DtAssistantNetworkCompViewMgr::tick(), DtAssistantFederationsInfoMgr::tick(), DtAssistantFederationsInfoMgr::updateFederateWarningTickInterval(), DtAssistantFederationsInfoMgr::viewFederationsForConnection(), DtAssistantNetworkCompInfoMgr::viewNetworkComponentsForConnection(), DtAssistantComponentMgr::~DtAssistantComponentMgr(), DtAssistantConnQueryMgr::~DtAssistantConnQueryMgr(), DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr(), DtAssistantFederationsViewMgr::~DtAssistantFederationsViewMgr(), DtAssistantLatencyTestMgr::~DtAssistantLatencyTestMgr(), DtAssistantLicenseQueryMgr::~DtAssistantLicenseQueryMgr(), DtAssistantNetworkCompInfoMgr::~DtAssistantNetworkCompInfoMgr(), DtAssistantNetworkCompViewMgr::~DtAssistantNetworkCompViewMgr(), DtAssistantPopupMsgMgr::~DtAssistantPopupMsgMgr(), and DtAssistantTrayIconMgr::~DtAssistantTrayIconMgr().

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

Referenced by dialogsVisible(), finishDialog(), startDialog(), and ~DtAssistantMgr().

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.

Referenced by displayWarningDialogs(), showDialog(), and startDialog().

QIcon DtAssistantMgr::theAboutIcon [static, protected]
QIcon DtAssistantMgr::theHelpIcon [static, protected]
bool DtAssistantMgr::theIconsAreLoaded = false [static, protected]

Whether or not the icons have yet been loaded.

Referenced by DtAssistantMgr().

QIcon DtAssistantMgr::theNotifyRtiIcon [static, protected]
QIcon DtAssistantMgr::thePreferencesIcon [static, protected]
QIcon DtAssistantMgr::theRtiIcon [static, protected]
QIcon DtAssistantMgr::theWarningRtiIcon [static, protected]
QIcon DtAssistantMgr::theWebIcon [static, protected]

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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)