MAK RTIspy API Documentation for HLA Evolved
Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtFederationsViewDialog Class Reference
+ Inheritance diagram for DtFederationsViewDialog:
+ Collaboration diagram for DtFederationsViewDialog:

List of all members.

Public Slots

virtual void processConnectionSelection (int index, bool ignoreVisibility=false)
 Processes the selection of a new connection.
virtual void showHelpDialog ()
 Shows the help dialog.
virtual void processHelpDialogClose ()
 Handles cleanup of the help dialog after it is closed.
virtual void showRidDialog ()
 Shows the RID dialog.
virtual void clearRidParams ()
 Clears the parameters currently displayed in the RID dialog.
virtual void enableOrDisableRidViewing (const DtRtiConnectionInfo &conn)
 Enables or disables RID viewing based on selected connection.
virtual void updateFederateRemovalTime (float period)
 Processes an update to the defunct federate removal period.
virtual void enableWebSpy (bool enable)
 Processes a command to enable/disable the rtiexec web spy view command.
float getFederateRemovalTime () const
 Get the federate Removal time.
virtual void updateFedViewWidgetEnable (const QString &)
 Update the Federations View "Network Testing: " widget.
virtual void updateFedViewWidgetDisable (const QString &)

Signals

void viewedConnectionChanged (const DtRtiConnectionInfo &conn)
 Emitted when the user chooses to update the connection to be viewed.
void forceFederateResign (int, const QString &)
 Emitted when user has requested to resign a federate.
void forceFederationDestroy (const QString &)
 Emitted when user has requested to destroy a federation.
void showRtiexecWebSpy ()
 Emitted to request display of the current rtiexec's web spy page.
void showFederateWebSpy (const QString &fedexName, int fedHandle)
 Emitted to request display a web spy page for the given federate.
void requestRidParams ()
 Emitted when RID parameters for the current rtiexec are requested.
void showLatencyTestDialog (const QString &fedexName, int fedHandle)
 Emitted when a latency test is requested.
void aboutDialogRequested ()
 Emitted when the RTI about dialog is requested.
void enableNetworkTesting (const QString &fedexName)
 Emitted to enable network testing for the given federation.
void disableNetworkTesting (const QString &fedexName)
 Emitted to disable network testing for the given federation.
void saveToLog ()
 Emitted when a user requests to save the currently displayed federation information to a log file.

Public Member Functions

 DtFederationsViewDialog (const MAKRti::DtFilename &configDir, QWidget *parent=0, Qt::WindowFlags flags=0)
 Constructor.
virtual ~DtFederationsViewDialog ()
 Destructor.
virtual void tick ()
 Performs periodic functions.
virtual int addConnection (const MAKRti::DtString &name, const DtRtiConnectionInfo &conn, bool isLocal)
 Adds a connection to the list of viewable connections.
virtual void removeConnection (const MAKRti::DtString &name)
 Removes an rtiexec from the list of viewable rtiexecs.
virtual void setConnectionIsLocal (const MAKRti::DtString &name, bool isLocal)
 Changes the state of whether the given connection is local.
virtual void updateFederations (const DtFederationStateByNameMap &federations)
 Updates the displayed federation information for the currently displayed connection.
virtual void updateFederation (const DtAssistantFederationInfo &federation)
 Updates a federation of the currently displayed connection.
virtual void removeFederation (const MAKRti::DtString &federationName)
 Removes a federation from the currently displayed connection.
virtual void removeAllFederations ()
 Removes all federations from the display.
virtual void updateFederate (const DtAssistantFederateInfo &federate, const MAKRti::DtString &federationName)
 Updates a federate in the given federation of the currently displayed connection.
virtual void removeFederate (int federateHandle, const MAKRti::DtString &federationName)
 Removes a federate from the given federation of the currently displayed connection.
virtual void updateSyncPoint (const MAKRti::DtString &syncPtName, const DtPendingAchievedPair &pendAchvFeds, const DtFederateInfoByHandleMap &federates, const MAKRti::DtString &federationName)
 Updates the sync pt in the given federation of the currently displayed connection.
virtual void removeSyncPoint (const MAKRti::DtString &syncPtName, const MAKRti::DtString &federationName)
 Removes the sync pt in the given federation of the currently displayed connection.
virtual void updateFederateTestStatus (const DtAssistantFederateInfo &federate, const MAKRti::DtString &federationName, bool isRunningTest, int numInitiated, int numReports)
 Updates a federate in the given federation of the currently displayed connection.
virtual bool selectedConnection (DtRtiConnectionInfo &conn) const
 If there is a currently selected connection, its information is populated in the given connection information.
virtual int selectedConnection () const
 If there is a currently selected rtiexec, return its index.
virtual void updateRidParams (const MAKRti::DtString &params, const MAKRti::DtString &hostName, const MAKRti::DtString &filename)
 Updates the current RID params.
virtual void enableCommands (bool enable)
 Enables or disables the rtiexec command options (shutdown, resign federate, destroy federation).
virtual void displayLoadingIndication ()
 Displays a message that the current federation information is loading.
virtual void removeLoadingIndication ()
 Removes the loading indication messages.
virtual void saveGuiState ()
 Saves the current GUI state to file.
virtual QMenucreatePopupMenu ()
 Override Qt function to create menu when right clicking menu bar.
virtual void clearFederationActions ()
 Removes all the federation view menu.

Protected Member Functions

virtual void addFederationWidget (const DtAssistantFederationInfo &federationState)
 Adds a new federation widget to the main window.
virtual void removeFederationWidget (const QString &federationName, const QString &federationMenuName)
 Removes and deletes a federation widget from the main window.
virtual void addFederationMenuAction (QAction *action)
 Adds an action to the federation view menu.
virtual void removeFederationMenuAction (const QString &name)
 Removes an item from the federation view menu.
virtual void showEvent (QShowEvent *event)
 Handles the showing of this dialog.
virtual void closeEvent (QCloseEvent *event)
 Handles the closing of this dialog.
virtual void keyPressEvent (QKeyEvent *event)
 Handles key press events.
virtual void convertToFederateTreeStrings (std::map< QString, std::pair< int, bool > > &columns) const
virtual void convertToConfigStrings (std::map< QString, std::pair< int, bool > > &columns) const
virtual void fedExNameAndFedHandleToString (const QString &fedExName, int fedHandle, QString &str)
 Combines a fedEx name and federate handle into a single string.
virtual void stringToFedExNameAndFedHandle (const QString &str, QString &fedExName, int &fedHandle)
 Extracts the fedEx name and federate handle from a string created by fedExNameAndFedHandleToString().
Setup methods
void setupConnectionComboBox ()
 Sets up the connection combo box.
void setupFederateTree ()
 Sets up the federate tree, including the initial column display and the View/Column menu actions.
void setupMenus ()
 Populates the menus with the submenus and actions.
void connectSignals ()
 Connects Qt signals and slots.

Protected Attributes

Ui::FederationsViewDialog myUiImpl
DtWidgetDialogmyRidDialog
 RID display dialog.
DtRidWidgetmyRidWidget
 Widget that displays the RID parameters.
QProcess * myHelpAssistant
 Help application.
DtFederateTreemyFederateTree
 Federate tree.
QComboBox * myConnectionComboBox
 Combo box for selecting a connection.
DtRIDParametersmyRidParams
 RID parameters of the currently displayed rtiexec.
std::map< QString, QDockWidget * > myFederationWidgets
 Federation dock widgets.
DtBoost::shared_ptr< DtExecConfigmyExecConfig
 Configuration information.
QIcon myCompliantIcon
 Compliant / non-compliant icons.
QIcon myNonCompliantIcon
std::map< QString,
DtRtiConnectionInfo
myConnsByName
 Name to connection info map.
QString myLastViewedConnection
 Name of connection shown last time dialog was displayed.
QSignalMapper * myLatencyTestObservingMapper
 Signal mappers for each of the latency test dialog signals.
QSignalMapper * myLatencyTestRunMapper
 Signal mappers for each of the latency test dialog signals.
QSignalMapper * myLatencyTestRunContinuousMapper
 Signal mappers for each of the latency test dialog signals.
QSignalMapper * myLatencyTestStopMapper
 Signal mappers for each of the latency test dialog signals.
QSignalMapper * myLatencyTestDismissMapper
 Signal mappers for each of the latency test dialog signals.
Menus and actions
QAction * mySaveAction
 File menu Save to file action.
QAction * myCloseAction
 Close dialog action.
QAction * myOpenWebSpyAction
 View menu Web spy.
QMenumyFedColumnMenu
 Federate tree column view menu.
QMenumyViewFederationMenu
 Federation display menu.
std::map< QString, QAction * > myFederationActions
 Federation display menu actions.
QAction * myViewRidAction
 RID parameter display menu action.
QMenumyFederateMenu
 Federate menu.
QMenumyFederationMenu
 Federation Menu.
QAction * myHelpAction
 Help menu.
QAction * myAboutAction
 File menu Save to file action.

Static Protected Attributes

static QString theNoConnectionsText = tr("No known active connections available")
 Text displayed in the combo box if there are no known active connections.

Constructor & Destructor Documentation

DtFederationsViewDialog::DtFederationsViewDialog ( const MAKRti::DtFilename &  configDir,
QWidget parent = 0,
Qt::WindowFlags  flags = 0 
)

Destructor.

References myHelpAssistant, and myRidDialog.


Member Function Documentation

Emitted when the RTI about dialog is requested.

Referenced by connectSignals().

int DtFederationsViewDialog::addConnection ( const MAKRti::DtString &  name,
const DtRtiConnectionInfo conn,
bool  isLocal 
) [virtual]

Adds a connection to the list of viewable connections.

Returns the index of the new connection (index is only useful internally to this class). If isLocal is true this connection will be identified as a potential default connection to be shown.

References myConnectionComboBox, myConnsByName, processConnectionSelection(), and theNoConnectionsText.

Referenced by DtAssistantFederationsViewMgr::processConnectionsUpdate().

void DtFederationsViewDialog::addFederationMenuAction ( QAction *  action) [protected, virtual]

Adds an action to the federation view menu.

References myFederationActions, and myViewFederationMenu.

Referenced by addFederationWidget().

void DtFederationsViewDialog::addFederationWidget ( const DtAssistantFederationInfo federationState) [protected, virtual]

Removes all the federation view menu.

References myFederationActions.

Referenced by DtAssistantFederationsViewMgr::changeViewedConnection().

void DtFederationsViewDialog::clearRidParams ( ) [virtual, slot]

Clears the parameters currently displayed in the RID dialog.

References DtRidWidget::clearRidParams(), myRidParams, and myRidWidget.

Referenced by connectSignals().

void DtFederationsViewDialog::closeEvent ( QCloseEvent *  event) [protected, virtual]

Handles the closing of this dialog.

References processConnectionSelection().

void DtFederationsViewDialog::convertToConfigStrings ( std::map< QString, std::pair< int, bool > > &  columns) const [protected, virtual]
void DtFederationsViewDialog::convertToFederateTreeStrings ( std::map< QString, std::pair< int, bool > > &  columns) const [protected, virtual]

Override Qt function to create menu when right clicking menu bar.

void DtFederationsViewDialog::disableNetworkTesting ( const QString &  fedexName) [signal]

Emitted to disable network testing for the given federation.

Referenced by connectSignals().

Displays a message that the current federation information is loading.

References DtFederateTree::displayLoadingIndication(), and myFederateTree.

Referenced by DtAssistantFederationsViewMgr::changeViewedConnection().

void DtFederationsViewDialog::enableCommands ( bool  enable) [virtual]

Enables or disables the rtiexec command options (shutdown, resign federate, destroy federation).

References DtFederateTree::enableDeletion(), and myFederateTree.

Referenced by DtAssistantFederationsViewMgr::changeViewedConnection(), and DtAssistantFederationsViewMgr::tick().

void DtFederationsViewDialog::enableNetworkTesting ( const QString &  fedexName) [signal]

Emitted to enable network testing for the given federation.

Referenced by connectSignals().

Enables or disables RID viewing based on selected connection.

References DtRtiConnectionInfo::isValid(), myViewRidAction, and DtRtiConnectionInfo::useRtiexec().

Referenced by connectSignals().

void DtFederationsViewDialog::enableWebSpy ( bool  enable) [virtual, slot]

Processes a command to enable/disable the rtiexec web spy view command.

References myOpenWebSpyAction.

Referenced by DtAssistantFederationsViewMgr::changeViewedConnection(), and DtAssistantFederationsViewMgr::processViewedWebSpyInfoUpdated().

void DtFederationsViewDialog::fedExNameAndFedHandleToString ( const QString &  fedExName,
int  fedHandle,
QString &  str 
) [protected, virtual]

Combines a fedEx name and federate handle into a single string.

void DtFederationsViewDialog::forceFederateResign ( int  ,
const QString &   
) [signal]

Emitted when user has requested to resign a federate.

Referenced by connectSignals().

void DtFederationsViewDialog::forceFederationDestroy ( const QString &  ) [signal]

Emitted when user has requested to destroy a federation.

Referenced by connectSignals().

Get the federate Removal time.

References DtFederateTree::getFederateRemovalTime(), and myFederateTree.

void DtFederationsViewDialog::keyPressEvent ( QKeyEvent *  event) [protected, virtual]

Handles key press events.

References showHelpDialog().

void DtFederationsViewDialog::processConnectionSelection ( int  index,
bool  ignoreVisibility = false 
) [virtual, slot]

Processes the selection of a new connection.

If ignoreVisibility is set, the selection change will be processed even if the dialog is not visible.

References DtRtiConnectionInfo::invalidConn(), myConnectionComboBox, myConnsByName, myLastViewedConnection, and viewedConnectionChanged().

Referenced by addConnection(), closeEvent(), connectSignals(), and showEvent().

Handles cleanup of the help dialog after it is closed.

References myHelpAssistant.

Referenced by showHelpDialog().

void DtFederationsViewDialog::removeConnection ( const MAKRti::DtString &  name) [virtual]

Removes an rtiexec from the list of viewable rtiexecs.

References myConnectionComboBox, myConnsByName, myLastViewedConnection, and theNoConnectionsText.

Referenced by DtAssistantFederationsViewMgr::processConnectionRemoval().

void DtFederationsViewDialog::removeFederate ( int  federateHandle,
const MAKRti::DtString &  federationName 
) [virtual]

Removes a federate from the given federation of the currently displayed connection.

References myFederateTree, myFederationWidgets, and DtFederateTree::removeFederate().

Referenced by DtAssistantFederationsViewMgr::processFederateRemoved().

void DtFederationsViewDialog::removeFederation ( const MAKRti::DtString &  federationName) [virtual]
void DtFederationsViewDialog::removeFederationMenuAction ( const QString &  name) [protected, virtual]

Removes an item from the federation view menu.

References myFederationActions, and myViewFederationMenu.

Referenced by removeAllFederations(), and removeFederationWidget().

void DtFederationsViewDialog::removeFederationWidget ( const QString &  federationName,
const QString &  federationMenuName 
) [protected, virtual]

Removes and deletes a federation widget from the main window.

References myFederationWidgets, and removeFederationMenuAction().

Referenced by removeFederation().

Removes the loading indication messages.

References myFederateTree, and DtFederateTree::removeLoadingIndication().

Referenced by DtAssistantFederationsViewMgr::removeLoadingIndication().

void DtFederationsViewDialog::removeSyncPoint ( const MAKRti::DtString &  syncPtName,
const MAKRti::DtString &  federationName 
) [virtual]

Removes the sync pt in the given federation of the currently displayed connection.

References myFederationWidgets.

Emitted when RID parameters for the current rtiexec are requested.

Referenced by showRidDialog().

Emitted when a user requests to save the currently displayed federation information to a log file.

Referenced by connectSignals().

If there is a currently selected connection, its information is populated in the given connection information.

Otherwise returns false and sets the connection info to an invalid value.

References DtRtiConnectionInfo::invalidConn(), myConnectionComboBox, and myConnsByName.

If there is a currently selected rtiexec, return its index.

References myConnectionComboBox.

void DtFederationsViewDialog::setConnectionIsLocal ( const MAKRti::DtString &  name,
bool  isLocal 
) [virtual]

Changes the state of whether the given connection is local.

References myConnectionComboBox.

Sets up the connection combo box.

References myConnectionComboBox, myUiImpl, and theNoConnectionsText.

Referenced by DtFederationsViewDialog().

Sets up the federate tree, including the initial column display and the View/Column menu actions.

References convertToFederateTreeStrings(), myExecConfig, myFederateTree, myUiImpl, and DtFederateTree::setAllColumns().

Referenced by DtFederationsViewDialog().

void DtFederationsViewDialog::showEvent ( QShowEvent *  event) [protected, virtual]

Handles the showing of this dialog.

References myConnectionComboBox, myLastViewedConnection, and processConnectionSelection().

void DtFederationsViewDialog::showFederateWebSpy ( const QString &  fedexName,
int  fedHandle 
) [signal]

Emitted to request display a web spy page for the given federate.

Referenced by connectSignals().

void DtFederationsViewDialog::showHelpDialog ( ) [virtual, slot]

Shows the help dialog.

References connect(), DtRtiLibPath(), myHelpAssistant, and processHelpDialogClose().

Referenced by connectSignals(), and keyPressEvent().

void DtFederationsViewDialog::showLatencyTestDialog ( const QString &  fedexName,
int  fedHandle 
) [signal]

Emitted when a latency test is requested.

Referenced by connectSignals().

void DtFederationsViewDialog::showRidDialog ( ) [virtual, slot]

Emitted to request display of the current rtiexec's web spy page.

Referenced by connectSignals().

void DtFederationsViewDialog::stringToFedExNameAndFedHandle ( const QString &  str,
QString &  fedExName,
int &  fedHandle 
) [protected, virtual]

Extracts the fedEx name and federate handle from a string created by fedExNameAndFedHandleToString().

void DtFederationsViewDialog::tick ( ) [virtual]

Performs periodic functions.

References myFederateTree, and DtFederateTree::processInvalidList().

Referenced by DtAssistantFederationsViewMgr::tick().

void DtFederationsViewDialog::updateFederate ( const DtAssistantFederateInfo federate,
const MAKRti::DtString &  federationName 
) [virtual]

Updates a federate in the given federation of the currently displayed connection.

Adds the federate if it does not already exist.

References myFederateTree, myFederationWidgets, and DtFederateTree::updateFederate().

Referenced by DtAssistantFederationsViewMgr::processFederateUpdated().

void DtFederationsViewDialog::updateFederateRemovalTime ( float  period) [virtual, slot]

Processes an update to the defunct federate removal period.

References myFederateTree, and DtFederateTree::setFederateRemovalTime().

Referenced by DtAssistantFederationsViewMgr::DtAssistantFederationsViewMgr().

void DtFederationsViewDialog::updateFederateTestStatus ( const DtAssistantFederateInfo federate,
const MAKRti::DtString &  federationName,
bool  isRunningTest,
int  numInitiated,
int  numReports 
) [virtual]

Updates a federate in the given federation of the currently displayed connection.

Adds the federate if it does not already exist.

Updates a federation of the currently displayed connection.

Adds the federation if it does not already exist.

References addFederationWidget(), DtAssistantFederationInfo::federationName(), myFederateTree, myFederationWidgets, and DtFederateTree::updateFederation().

Referenced by DtAssistantFederationsViewMgr::processFederationUpdate(), and updateFederations().

Updates the displayed federation information for the currently displayed connection.

References updateFederation().

Referenced by DtAssistantFederationsViewMgr::changeViewedConnection().

void DtFederationsViewDialog::updateFedViewWidgetDisable ( const QString &  federationName) [virtual, slot]

References myFederationWidgets.

Referenced by connectSignals().

void DtFederationsViewDialog::updateFedViewWidgetEnable ( const QString &  federationName) [virtual, slot]

Update the Federations View "Network Testing: " widget.

References myFederationWidgets.

Referenced by connectSignals().

void DtFederationsViewDialog::updateRidParams ( const MAKRti::DtString &  params,
const MAKRti::DtString &  hostName,
const MAKRti::DtString &  filename 
) [virtual]
void DtFederationsViewDialog::updateSyncPoint ( const MAKRti::DtString &  syncPtName,
const DtPendingAchievedPair pendAchvFeds,
const DtFederateInfoByHandleMap federates,
const MAKRti::DtString &  federationName 
) [virtual]

Updates the sync pt in the given federation of the currently displayed connection.

Adds the sync point if it does not already exist.

References myFederationWidgets.

Emitted when the user chooses to update the connection to be viewed.

Referenced by connectSignals(), and processConnectionSelection().


Member Data Documentation

File menu Save to file action.

Referenced by connectSignals(), and setupMenus().

Close dialog action.

Referenced by connectSignals(), and setupMenus().

Compliant / non-compliant icons.

Name to connection info map.

Referenced by addConnection(), processConnectionSelection(), removeConnection(), and selectedConnection().

DtBoost::shared_ptr<DtExecConfig> DtFederationsViewDialog::myExecConfig [protected]

Configuration information.

Referenced by DtFederationsViewDialog(), saveGuiState(), and setupFederateTree().

Federate tree column view menu.

Referenced by setupMenus().

Federate menu.

Referenced by setupMenus().

std::map< QString, QAction* > DtFederationsViewDialog::myFederationActions [protected]

Federation display menu actions.

Referenced by addFederationMenuAction(), clearFederationActions(), and removeFederationMenuAction().

Federation Menu.

Referenced by setupMenus().

std::map< QString, QDockWidget* > DtFederationsViewDialog::myFederationWidgets [protected]

Help menu.

Referenced by connectSignals(), and setupMenus().

Name of connection shown last time dialog was displayed.

Referenced by processConnectionSelection(), removeConnection(), and showEvent().

Signal mappers for each of the latency test dialog signals.

Signal mappers for each of the latency test dialog signals.

Signal mappers for each of the latency test dialog signals.

Signal mappers for each of the latency test dialog signals.

Signal mappers for each of the latency test dialog signals.

View menu Web spy.

Referenced by connectSignals(), enableWebSpy(), removeAllFederations(), and setupMenus().

RID display dialog.

Referenced by showRidDialog(), and ~DtFederationsViewDialog().

RID parameters of the currently displayed rtiexec.

Referenced by clearRidParams(), showRidDialog(), and updateRidParams().

Widget that displays the RID parameters.

Referenced by clearRidParams(), showRidDialog(), and updateRidParams().

File menu Save to file action.

Referenced by connectSignals(), and setupMenus().

Ui::FederationsViewDialog DtFederationsViewDialog::myUiImpl [protected]

Federation display menu.

Referenced by addFederationMenuAction(), removeFederationMenuAction(), and setupMenus().

RID parameter display menu action.

Referenced by connectSignals(), enableOrDisableRidViewing(), and setupMenus().

QString DtFederationsViewDialog::theNoConnectionsText = tr("No known active connections available") [static, protected]

Text displayed in the combo box if there are no known active connections.

Referenced by addConnection(), removeConnection(), and setupConnectionComboBox().


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)