MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtAssistantConnQueryMgr Class Reference

Maintains list of known RTI connections and processes connection queries from RTI components. More...

+ Inheritance diagram for DtAssistantConnQueryMgr:
+ Collaboration diagram for DtAssistantConnQueryMgr:

Public Slots

void processConnectionsUpdate (const DtRtiConnectionAndConfiguration &conns)
 Processes an update to existing connections or the discovery of new connections. More...
 
void processConnectionsRemoval (const DtRtiConnectionAndConfiguration &conns)
 Processes the removal of existing connections. More...
 
void processAssistantFound (const DtAssistantInfo &assistant)
 Process the discovery of a remote assistant. More...
 
void processAssistantLost (const DtAssistantInfo &assistant)
 Process the loss of a discovered remote assistant. More...
 
void processConnQueryAccepted (QWidget *widget)
 Processes the acceptance of a connection query dialog. More...
 
void processConnQueryRejected (QWidget *widget)
 Processes the rejection of a connection query dialog. More...
 
void captureStartRtiexec (const DtRtiConnectionInfoDataPair &, const DtRtiConnectionConfigurationInfo &, bool)
 Starts an rtiexec with the given connection and configuration. More...
 
void captureEditRtiConfigurations ()
 Shows the RTI Configuration editing page of the preferences dialog. More...
 
void addProhibitedPort (int port, const MAKRti::DtString &reason)
 Adds a port that will not be allowed to use in choosing a connection. More...
 
void removeProhibitedPort (int port)
 Removes a port that will not be allowed to use in choosing a connection. More...
 
void closeConnQueryDialog (const DtAssistantComponentInfo *info)
 Closes the displayed connection query dialog if it matches the given ID. More...
 
void processNewUserAddedConnection (const DtRtiConnectionInfoDataPair &, DtAssistantConnQueryWidget *)
 Processes the addition of a new user defined connection that has not yet been accepted. More...
 
void checkForConflictingUnsavedConns (DtAssistantConnQueryWidget *widget)
 Checks the unsaved user-added connections from the given widget in order to set whether the connection is conflicting or not. More...
 
void setStartRtiexecEnableBasedOnConn (const DtRtiConnectionInfoDataPair &)
 Enables or disables the "Start rtiexec" functionality based on the given connection. More...
 
void internalConnectionQuery (DtAssistantComponentType componentType)
 Handle a internal connection query. More...
 
virtual void refreshConfigurationList ()
 Refresh instantiated conn query widgets with the latest configurations from the RID Info manager. More...
 
void processRtiSettingsNameSelected (const MAKRti::DtString &, bool)
 Selects the proper RTI Setting from the combo box. More...
 
- Public Slots inherited from DtAssistantMgr
void displayWarningDialogs ()
 Displays all warning dialogs. More...
 

Signals

void showConfigDialog (DtPreferencesPage pageNum=DtInvalidPreferencesPage)
 Signal to show the RID Configuration page. More...
 
void startRtiexec (const DtRtiConnectionInfoDataPair &conn, const DtRtiConnectionConfigurationInfo &config, bool accepted)
 Signal to start an rtiexec with given configuration. More...
 
void startRtiForwarder (const DtRtiConnectionInfoDataPair &conn, const DtRtiConnectionConfigurationInfo &config, bool accepted)
 Signal to start an rti forwarder with given configuration. More...
 
- Signals inherited from DtAssistantMgr
void warningDialogDisplayed ()
 Emitted when a warning dialog is displayed. More...
 
void warningDialogDismissed ()
 Emitted when a warning dialog is dismissed. More...
 
void popupRequested (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
 Emitted when a popup dialog should be displayed. More...
 
void popupRequested (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
 Emitted when a popup dialog should be displayed. More...
 
void notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId, bool logOnly)
 Emitted when a notification should be displayed. More...
 
void notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source, bool logOnly)
 Emitted when a notification should be displayed. More...
 

Public Member Functions

 DtAssistantConnQueryMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, DtBoost::shared_ptr< DtAssistantComponentMgr > compMgr, DtBoost::shared_ptr< DtAssistantRidConfigInfoMgr > ridInfoMgr, DtBoost::shared_ptr< DtAssistantConnectionInfoMgr > connInfoMgr)
 Constructor. More...
 
virtual ~DtAssistantConnQueryMgr ()
 Destructor. More...
 
virtual void tick ()
 Performs tasks that need to be completed periodically. More...
 
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. More...
 
virtual void updateConfigWidget ()
 Forces the configuration widget to be updated. More...
 
virtual void processConfigWidgetAccept ()
 Process the changes that were accepted in the configuration widget. More...
 
virtual bool updateConfigFromWidgetResults (DtRtiConnectionInfoDataPair &connInfo, DtRtiConnectionConfigurationInfo &config, DtAssistantConnQueryWidget *widget)
 Updates the stored configuration from the results of widget. More...
 
virtual void updateConnQueryWidget (DtAssistantConnQueryWidget *widget, bool preserveSelection)
 Updates the given connection query widget with the latest RTI connections from the cache. More...
 
- Public Member Functions inherited from DtAssistantMgr
 DtAssistantMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
 Constructor. More...
 
virtual ~DtAssistantMgr ()
 Destructor. More...
 
virtual void initialize ()
 Initializes this manager just prior to beginning assistant processing. More...
 
virtual void startShutdown ()
 Performs any necessary processing at the start of shutdown. More...
 
virtual bool dialogsVisible () const
 Determines if there are any visible dialogs for which this manager is responsible. More...
 

Protected Member Functions

virtual bool checkForInterfaces ()
 Checks for the existence of at least one usable network interface. More...
 
void processConnQueryResults (QWidget *widget, bool accepted)
 Processes the results of a connection query. More...
 
virtual void processUserAddedConnections (const DtRtiConnectionAndConfiguration &conns)
 Process the addition of new connections. More...
 
virtual void processUserRemovedConnections (const DtRtiConnectionAndConfiguration &conns)
 Process the removal of connections. More...
 
virtual void addToAllConnQuery (const DtRtiConnectionAndConfiguration &conns)
 Adds a set of connections and configurations to all connection query widgets. More...
 
virtual void removeFromAllConnQuery (const DtRtiConnectionAndConfiguration &conns)
 Removes the set of connections to all connection query widgets. More...
 
virtual void setConfigurationMetaData (DtRtiConnectionConfigurationInfo &config)
 Refreshes the RID lisp in the configuration with the latest from disk. More...
 
void setChosenConnection (const DtRtiConnectionInfo &conn, const DtRtiConnectionConfigurationInfo &config)
 Process a request to set the connection and config chosen to be used automatically in the future. More...
 
void clearChosenConnection ()
 Process a request to remove the connection chosen to be used automatically in the future. More...
 
- Protected Member Functions inherited from DtAssistantMgr
void startDialog (QDialog *dlg, bool inTaskbar, bool warningDialog)
 Sets up the given widget as a dialog. More...
 
void finishDialog (QDialog *dlg)
 Should be called prior to deleting any dialog started with startDialog. More...
 
void showDialog (QDialog *dlg)
 Shows the dialog. More...
 
void startMainWindow (QMainWindow *dlg)
 Sets up a main window dialog. More...
 
void finishMainWindow (QMainWindow *dlg)
 Should be called prior to deleting any dialog started with startMainWindow. More...
 
void showMainWindow (QMainWindow *dlg)
 Shows the dialog. More...
 
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. More...
 
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. More...
 
void displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
 Displays and logs a notification from the given component. More...
 
void displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
 Displays and logs notification with the given component name. More...
 
void logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
 Logs a notification from the given component, does not display. More...
 
void logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
 Logs a notification with the given component name, does not display. More...
 
virtual DtAssistantInfo assistantInfoFromAssistantMsg (const DtAssistantMsg &assistantMsg, DtInetAddrSet *interfaces=0)
 

Protected Attributes

DtAssistantMsgQueue myConnQueryMsgQueue
 The queue which holds connection query messages. More...
 
DtBoost::shared_ptr
< DtAssistantComponentMgr
myCompMgr
 The manager that keeps track of all local RTI components. More...
 
DtBoost::shared_ptr
< DtAssistantRidConfigInfoMgr
myRidInfoMgr
 The manager that keeps track of all RID configurations. More...
 
DtBoost::shared_ptr
< DtAssistantConnectionInfoMgr
myConnInfoMgr
 The manager that keeps track of all active and inactive connections. More...
 
DtClock myClock
 Clock for determining when local interfaces should be checked. More...
 
DtAssistantLrcConnQueryDialogmyLrcConnQueryDlg
 The dialog which queries the user for LRC connection information. More...
 
DtAssistantRtiexecConnQueryDialogmyRtiexecOrForwarderConnQueryDlg
 The dialog which queries the user for rtiexec or Forwarder connection information. More...
 
DtAssistantConnConfigWidgetmyConnConfigWidget
 Connection configuration widget to be inserted into the assistant configuration dialog. More...
 
DtAssistantNoInterfacesFoundDialog * myNoInterfacesFoundDialog
 The dialog that informs users that no network interfaces were found. More...
 
std::set< int > myCompsConnectingWithChosen
 The set of components that have been told to try to use the current chosen connection. More...
 
Signal mappers for the connection query dialogs.
QSignalMapper * myConnQueryAcceptedMapper
 
QSignalMapper * myConnQueryRejectedMapper
 
- Protected Attributes inherited from DtAssistantMgr
DtBoost::shared_ptr
< DtRtiAssistantServer
myServer
 The Assistant server from which new messages will arrive from local RTI components. More...
 
DtBoost::shared_ptr
< DtRtiAssistantPeer
myPeer
 The Assistant peer which communicates with other Assistants. More...
 
std::set< QDialog * > myUnparentedDialogs
 All unparented dialogs that are created by the GUI should be added to this set. More...
 
std::set< QMainWindow * > myMainWindows
 All main windows that are created by the GUI should be added to this set. More...
 
std::set< QDialog * > myWarningDialogs
 Set of the popup dialogs, either parented or unparented, which, when active, should cause a warning icon to be displayed. More...
 

Private Member Functions

 DtAssistantConnQueryMgr (const DtAssistantConnQueryMgr &)
 Copy Constructor not implemented – Copy Not Allowed! More...
 
DtAssistantConnQueryMgroperator= (const DtAssistantConnQueryMgr &)
 Assignment not implemented – Assignment Not Allowed! More...
 

Message Callbacks

Callbacks for connection query messages

static void addConnQueryMsgToQueue (const DtAssistantConnQueryMsg &msg, void *usr)
 Callback to add connection query message to queue. More...
 
static void processConnQueryMsg (const DtAssistantConnQueryMsg &msg, void *usr)
 Callback to process a connection query message from a component. More...
 
virtual void addConnQueryMsgToQueue (const DtAssistantConnQueryMsg &msg)
 Called by the callback function to add a message to the queue. More...
 
virtual void processConnQueryMsg (const DtAssistantConnQueryMsg &msg)
 Called by the callback function to process connection query messages. More...
 

Additional Inherited Members

- Static Protected Attributes inherited from DtAssistantMgr
static QIcon theRtiIcon
 The icons used by the RTI Assistant. More...
 
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. More...
 

Detailed Description

Maintains list of known RTI connections and processes connection queries from RTI components.

Constructor & Destructor Documentation

DtAssistantConnQueryMgr::DtAssistantConnQueryMgr ( DtBoost::shared_ptr< DtRtiAssistantServer server,
DtBoost::shared_ptr< DtRtiAssistantPeer peer,
DtAssistantSignalRouter signalRouter,
DtBoost::shared_ptr< DtAssistantComponentMgr compMgr,
DtBoost::shared_ptr< DtAssistantRidConfigInfoMgr ridInfoMgr,
DtBoost::shared_ptr< DtAssistantConnectionInfoMgr connInfoMgr 
)

Constructor.

virtual DtAssistantConnQueryMgr::~DtAssistantConnQueryMgr ( )
virtual

Destructor.

DtAssistantConnQueryMgr::DtAssistantConnQueryMgr ( const DtAssistantConnQueryMgr )
private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

static void DtAssistantConnQueryMgr::addConnQueryMsgToQueue ( const DtAssistantConnQueryMsg msg,
void *  usr 
)
staticprotected

Callback to add connection query message to queue.

Connection query messages should be added to a queue in order to be processed one at a time. Two connection query dialogs should not be displayed at the same time.

virtual void DtAssistantConnQueryMgr::addConnQueryMsgToQueue ( const DtAssistantConnQueryMsg msg)
protectedvirtual

Called by the callback function to add a message to the queue.

void DtAssistantConnQueryMgr::addProhibitedPort ( int  port,
const MAKRti::DtString &  reason 
)
slot

Adds a port that will not be allowed to use in choosing a connection.

virtual void DtAssistantConnQueryMgr::addToAllConnQuery ( const DtRtiConnectionAndConfiguration conns)
protectedvirtual

Adds a set of connections and configurations to all connection query widgets.

void DtAssistantConnQueryMgr::captureEditRtiConfigurations ( )
slot

Shows the RTI Configuration editing page of the preferences dialog.

void DtAssistantConnQueryMgr::captureStartRtiexec ( const DtRtiConnectionInfoDataPair ,
const DtRtiConnectionConfigurationInfo ,
bool   
)
slot

Starts an rtiexec with the given connection and configuration.

void DtAssistantConnQueryMgr::checkForConflictingUnsavedConns ( DtAssistantConnQueryWidget widget)
slot

Checks the unsaved user-added connections from the given widget in order to set whether the connection is conflicting or not.

virtual bool DtAssistantConnQueryMgr::checkForInterfaces ( )
protectedvirtual

Checks for the existence of at least one usable network interface.

If not an error dialog will be displayed and the return value will be false.

void DtAssistantConnQueryMgr::clearChosenConnection ( )
protected

Process a request to remove the connection chosen to be used automatically in the future.

void DtAssistantConnQueryMgr::closeConnQueryDialog ( const DtAssistantComponentInfo info)
slot

Closes the displayed connection query dialog if it matches the given ID.

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

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

Reimplemented from DtAssistantMgr.

void DtAssistantConnQueryMgr::internalConnectionQuery ( DtAssistantComponentType  componentType)
slot

Handle a internal connection query.

DtAssistantConnQueryMgr& DtAssistantConnQueryMgr::operator= ( const DtAssistantConnQueryMgr )
private

Assignment not implemented – Assignment Not Allowed!

void DtAssistantConnQueryMgr::processAssistantFound ( const DtAssistantInfo assistant)
slot

Process the discovery of a remote assistant.

void DtAssistantConnQueryMgr::processAssistantLost ( const DtAssistantInfo assistant)
slot

Process the loss of a discovered remote assistant.

virtual void DtAssistantConnQueryMgr::processConfigWidgetAccept ( )
virtual

Process the changes that were accepted in the configuration widget.

Reimplemented from DtAssistantMgr.

void DtAssistantConnQueryMgr::processConnectionsRemoval ( const DtRtiConnectionAndConfiguration conns)
slot

Processes the removal of existing connections.

void DtAssistantConnQueryMgr::processConnectionsUpdate ( const DtRtiConnectionAndConfiguration conns)
slot

Processes an update to existing connections or the discovery of new connections.

void DtAssistantConnQueryMgr::processConnQueryAccepted ( QWidget widget)
slot

Processes the acceptance of a connection query dialog.

static void DtAssistantConnQueryMgr::processConnQueryMsg ( const DtAssistantConnQueryMsg msg,
void *  usr 
)
staticprotected

Callback to process a connection query message from a component.

virtual void DtAssistantConnQueryMgr::processConnQueryMsg ( const DtAssistantConnQueryMsg msg)
protectedvirtual

Called by the callback function to process connection query messages.

void DtAssistantConnQueryMgr::processConnQueryRejected ( QWidget widget)
slot

Processes the rejection of a connection query dialog.

void DtAssistantConnQueryMgr::processConnQueryResults ( QWidget widget,
bool  accepted 
)
protected

Processes the results of a connection query.

void DtAssistantConnQueryMgr::processNewUserAddedConnection ( const DtRtiConnectionInfoDataPair ,
DtAssistantConnQueryWidget  
)
slot

Processes the addition of a new user defined connection that has not yet been accepted.

void DtAssistantConnQueryMgr::processRtiSettingsNameSelected ( const MAKRti::DtString &  ,
bool   
)
slot

Selects the proper RTI Setting from the combo box.

virtual void DtAssistantConnQueryMgr::processUserAddedConnections ( const DtRtiConnectionAndConfiguration conns)
protectedvirtual

Process the addition of new connections.

virtual void DtAssistantConnQueryMgr::processUserRemovedConnections ( const DtRtiConnectionAndConfiguration conns)
protectedvirtual

Process the removal of connections.

virtual void DtAssistantConnQueryMgr::refreshConfigurationList ( )
virtualslot

Refresh instantiated conn query widgets with the latest configurations from the RID Info manager.

virtual void DtAssistantConnQueryMgr::removeFromAllConnQuery ( const DtRtiConnectionAndConfiguration conns)
protectedvirtual

Removes the set of connections to all connection query widgets.

void DtAssistantConnQueryMgr::removeProhibitedPort ( int  port)
slot

Removes a port that will not be allowed to use in choosing a connection.

void DtAssistantConnQueryMgr::setChosenConnection ( const DtRtiConnectionInfo conn,
const DtRtiConnectionConfigurationInfo config 
)
protected

Process a request to set the connection and config chosen to be used automatically in the future.

virtual void DtAssistantConnQueryMgr::setConfigurationMetaData ( DtRtiConnectionConfigurationInfo config)
protectedvirtual

Refreshes the RID lisp in the configuration with the latest from disk.

void DtAssistantConnQueryMgr::setStartRtiexecEnableBasedOnConn ( const DtRtiConnectionInfoDataPair )
slot

Enables or disables the "Start rtiexec" functionality based on the given connection.

void DtAssistantConnQueryMgr::showConfigDialog ( DtPreferencesPage  pageNum = DtInvalidPreferencesPage)
signal

Signal to show the RID Configuration page.

void DtAssistantConnQueryMgr::startRtiexec ( const DtRtiConnectionInfoDataPair conn,
const DtRtiConnectionConfigurationInfo config,
bool  accepted 
)
signal

Signal to start an rtiexec with given configuration.

void DtAssistantConnQueryMgr::startRtiForwarder ( const DtRtiConnectionInfoDataPair conn,
const DtRtiConnectionConfigurationInfo config,
bool  accepted 
)
signal

Signal to start an rti forwarder with given configuration.

virtual void DtAssistantConnQueryMgr::tick ( )
virtual

Performs tasks that need to be completed periodically.

Reimplemented from DtAssistantMgr.

virtual bool DtAssistantConnQueryMgr::updateConfigFromWidgetResults ( DtRtiConnectionInfoDataPair connInfo,
DtRtiConnectionConfigurationInfo config,
DtAssistantConnQueryWidget widget 
)
virtual

Updates the stored configuration from the results of widget.

Sets connInfo and config with the currently selected connection information. Returns true if the connection was made the chosen connection.

virtual void DtAssistantConnQueryMgr::updateConfigWidget ( )
virtual

Forces the configuration widget to be updated.

Reimplemented from DtAssistantMgr.

virtual void DtAssistantConnQueryMgr::updateConnQueryWidget ( DtAssistantConnQueryWidget widget,
bool  preserveSelection 
)
virtual

Updates the given connection query widget with the latest RTI connections from the cache.

Will preserve the current selection in the dialog if preserveSelection is true.

Member Data Documentation

DtClock DtAssistantConnQueryMgr::myClock
protected

Clock for determining when local interfaces should be checked.

DtBoost::shared_ptr<DtAssistantComponentMgr> DtAssistantConnQueryMgr::myCompMgr
protected

The manager that keeps track of all local RTI components.

std::set<int> DtAssistantConnQueryMgr::myCompsConnectingWithChosen
protected

The set of components that have been told to try to use the current chosen connection.

DtAssistantConnConfigWidget* DtAssistantConnQueryMgr::myConnConfigWidget
protected

Connection configuration widget to be inserted into the assistant configuration dialog.

DtBoost::shared_ptr<DtAssistantConnectionInfoMgr> DtAssistantConnQueryMgr::myConnInfoMgr
protected

The manager that keeps track of all active and inactive connections.

QSignalMapper* DtAssistantConnQueryMgr::myConnQueryAcceptedMapper
protected
DtAssistantMsgQueue DtAssistantConnQueryMgr::myConnQueryMsgQueue
protected

The queue which holds connection query messages.

Only one may be processed at a time, but this should not prevent the processing of other messages.

QSignalMapper* DtAssistantConnQueryMgr::myConnQueryRejectedMapper
protected
DtAssistantLrcConnQueryDialog* DtAssistantConnQueryMgr::myLrcConnQueryDlg
protected

The dialog which queries the user for LRC connection information.

DtAssistantNoInterfacesFoundDialog* DtAssistantConnQueryMgr::myNoInterfacesFoundDialog
protected

The dialog that informs users that no network interfaces were found.

DtBoost::shared_ptr<DtAssistantRidConfigInfoMgr> DtAssistantConnQueryMgr::myRidInfoMgr
protected

The manager that keeps track of all RID configurations.

DtAssistantRtiexecConnQueryDialog* DtAssistantConnQueryMgr::myRtiexecOrForwarderConnQueryDlg
protected

The dialog which queries the user for rtiexec or Forwarder connection information.


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

Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)