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

List of all members.

Public Types

enum  DtNetworkComponentViewHeaderEnum {
  DtNetworkComponentViewProcess = 0, DtNetworkComponentViewIP, DtNetworkComponentViewHandle, DtNetworkComponentViewHostName,
  DtNetworkComponentViewQueueStatus, DtNetworkComponentViewName, DtNetworkComponentViewType, DtNetworkComponentViewPID,
  DtNetworkComponentViewCommandLine
}

Public Slots

virtual void processRtiForwarderSelection (int index, bool ignoreVisibility=false)
 Processes the selection of a new RTI Forwarder.
virtual void showHelpDialog ()
 Shows the help dialog.
virtual void processHelpDialogClose ()
 Handles cleanup of the help dialog after it is closed.
virtual void showEvent (QShowEvent *event)
 Override Qwidget's show function so we can display the correct forwarder.
virtual void closeEvent (QCloseEvent *event)
 Override Qwidget's close function so we can stop observers.
virtual void keyPressEvent (QKeyEvent *event)
 Handles key press events.
virtual void showContextMenu (const QPoint &)
 Shows the context menu at the given position.
virtual void shutdownCurrentRtiexec ()
 Processes a command to shutdown the current rtiexec.
virtual void shutdownCurrentRtiForwarder ()
 Processes a command to shutdown the current RTI Forwarder.

Signals

void viewedRtiForwarderChanged (const DtRtiConnectionInfo &conn)
 Emitted when the user chooses to update the RTI Forwarder should be viewed.
void requestLog ()
 Emitted when the full rtiexec log has been requested.
void shutdownRtiexec ()
 Emitted when the currently viewed rtiexec should be shutdown.
void shutdownForwarder ()
 Emitted when the currently viewed RTI Forwarder should be shutdown.
void aboutDialogRequested ()
 Emitted when the RTI about dialog is requested.
void showPopup (const MAKRti::DtString &, const MAKRti::DtString &, const MAKRti::DtString &)
 Emitted when a popup dialog from a remote rtiexec should be displayed.

Public Member Functions

 DtRtiNetworkComponentViewDialog (const MAKRti::DtFilename &configDir, QWidget *parent=0, Qt::WindowFlags flags=0)
 Constructor.
virtual ~DtRtiNetworkComponentViewDialog ()
 Destructor.
virtual void tick ()
 Performs periodic functions.
virtual void addRtiForwarder (const MAKRti::DtString &name, const DtRtiConnectionInfo &forwarderInfo, bool isLocal)
 Adds an RTI Forwarder to the list of viewable rtiForwarders.
virtual void removeRtiForwarder (const MAKRti::DtString &name)
 Removes an RTI Forwarder from the list of viewable rtiForwarders.
virtual void setConnectionIsLocal (const MAKRti::DtString &name, bool isLocal)
 Changes the state of whether the given forwarder connection is being used by a local component.
virtual bool selectedRtiForwarder (DtRtiConnectionInfo &forwarderInfo) const
 If there is a currently selected RTI Forwarder, its information is populated in the given connection information.
virtual int selectedRtiForwarder () const
 If there is a currently selected RTI Forwarder, return its index.
virtual void setData (const DtAssistantForwarderInfo &data)
 sets the data to be displayed.
virtual void clearData ()
 clears old data.
virtual void setViewedConnectionDescription (const DtRtiConnectionInfo &conn)
virtual MAKRti::DtString viewedConnectionDescription () const
virtual void writeToConsole (const char *text, MAKRti::DtNotifyLevelType notifyLevel)
 Writes a single line of output to the console.
virtual void clearConsole ()
 Clears all text from the console.
virtual void clearConnectionTree ()
 Clears all data from the connection tree.
virtual unsigned consoleTextSize () const
 Returns the size, in bytes, of the text currently displayed in the console.
virtual void updateNotifyLevel (MAKRti::DtNotifyLevelType level)
 Updates the notify level displayed in the console to match the current level.
virtual void enableCommands (bool enable)
 Enables or disables the rtiexec & forwarder shutdown option.
virtual void enableRtiExecShutdownCommand (bool enable)
 Enables or disables the rtiexec shutdown option.
virtual void enableRtiForwarderShutdownCommand (bool enable)
 Enables or disables the forwarder shutdown option.
virtual void displayLoadingIndication ()
 Displays a message that the current federation information is loading.
virtual void removeLoadingIndication ()
 Removes the loading indication messages.
void saveGuiState ()
 Saves the current GUI state to file.
Ui::NetworkComponentViewDialog getUiImpl () const

Protected Member Functions

Setup methods
void setupUI ()
 Sets up the RTI Forwarder combo box and the console widget.
void setupMenus ()
 Populates the menus with the submenus and actions.
void connectSignals ()
 Connects Qt signals and slots.

Protected Attributes

Ui::NetworkComponentViewDialog myUiImpl
QProcess * myHelpAssistant
 Help application.
QComboBox * myRtiForwarderComboBox
 Combo box for selecting an RTI Forwarder.
std::map< QString,
DtRtiConnectionInfo
myRtiForwarderConnsByName
 RTI Forwarder name to connection info map.
DtExecConsoleWidgetmyConsoleWidget
 Console widget and its dock widget.
QDockWidget * myConsoleDockWidget
bool myRtiExecInCurrentViewedConn
DtBoost::shared_ptr
< DtForwarderConfig
myForwarderConfig
 Configuration information.
QLabel * myRtiForwarderLabel
QHBoxLayout * myComboBoxLabelLayout
QVBoxLayout * myVLayout
QWidgetmyVLayoutWidget
QGridLayout * myPropertiesAreaLayout
QWidgetmyPropertiesAreaLayoutWidget
QSplitter * myTopSplitter
QSplitter * myBottomSplitter
MAKRti::DtString myViewedHostName
 The actual host name being viewed, not the one that was potentially edited for display in the host label on the GUI.
QTreeWidgetItem * myLoadingIndicationItem
 Item that indicates network component information is being loaded.
QString myLastViewedForwarder
 Name of forwarder connection shown last time dialog was displayed.
DtNCVTreemyTreeView
 The NCV Tree View.
Menus and actions
QAction * myCloseAction
 File menu.
QAction * myShutdownAction
 File menu.
QAction * myShutdownForwarderAction
 File menu.
QTreeWidgetItem * myExecItem
 File menu.
QTreeWidgetItem * myCurrentViewedItem
 File menu.
QAction * myHelpAction
 Help menu.
QAction * myAboutAction
 File menu.
QAction * myConsoleAction
 Console display menu action.
QMenumyContextMenu
 File menu.
QMenumyCompColumnMenu
 Component tree column view menu.
QLabel * myDescriptionLabel
 File menu.
QLabel * myHostHeaderLabel
 File menu.
QLabel * myBEAddrHeaderLabel
 File menu.
QLabel * myBEPortHeaderLabel
 File menu.
QLabel * myRelPortHeaderLabel
 File menu.
QLabel * myNetworkInterfaceAddrHeaderLabel
 File menu.
QLabel * myForwarderPortHeaderLabel
 File menu.
QLabel * myHostLabel
 File menu.
QLabel * myBEAddrLabel
 File menu.
QLabel * myBEPortLabel
 File menu.
QLabel * myRelPortLabel
 File menu.
QLabel * myNetworkInterfaceAddrLabel
 File menu.
QLabel * myForwarderPortLabel
 File menu.

Static Protected Attributes

static QString theNoConnectionsAvailableText = tr("No known connections available")
 Text displayed in the combo box if there are no known rtiForwarders.
static const QString theLoadingText
 Text displayed when loading network component information.

Member Enumeration Documentation

Enumerator:
DtNetworkComponentViewProcess 
DtNetworkComponentViewIP 
DtNetworkComponentViewHandle 
DtNetworkComponentViewHostName 
DtNetworkComponentViewQueueStatus 
DtNetworkComponentViewName 
DtNetworkComponentViewType 
DtNetworkComponentViewPID 
DtNetworkComponentViewCommandLine 

Constructor & Destructor Documentation

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

Destructor.

References myHelpAssistant, and myRtiForwarderConnsByName.


Member Function Documentation

Emitted when the RTI about dialog is requested.

Referenced by connectSignals().

void DtRtiNetworkComponentViewDialog::addRtiForwarder ( const MAKRti::DtString &  name,
const DtRtiConnectionInfo forwarderInfo,
bool  isLocal 
) [virtual]

Clears all data from the connection tree.

References DtNCVTree::clearConnectionTree(), myTreeView, and removeLoadingIndication().

Referenced by clearData().

void DtRtiNetworkComponentViewDialog::closeEvent ( QCloseEvent *  event) [virtual, slot]

Override Qwidget's close function so we can stop observers.

References processRtiForwarderSelection().

Returns the size, in bytes, of the text currently displayed in the console.

References myConsoleWidget, and DtExecConsoleWidget::textSize().

Referenced by DtAssistantNetworkCompViewMgr::processRtiexecLogMsg().

Displays a message that the current federation information is loading.

References DtNCVTree::displayLoadingIndication(), and myTreeView.

Referenced by DtAssistantNetworkCompViewMgr::changeViewedRtiForwarder().

Enables or disables the rtiexec shutdown option.

References DtNCVTree::enableRtiExecCommand(), myTreeView, and DtNCVTree::refreshCommandsEnabled().

Referenced by DtAssistantNetworkCompViewMgr::tick().

Enables or disables the forwarder shutdown option.

References DtNCVTree::enableRtiForwarderCommand(), myTreeView, and DtNCVTree::refreshCommandsEnabled().

Referenced by DtAssistantNetworkCompViewMgr::tick().

Ui::NetworkComponentViewDialog DtRtiNetworkComponentViewDialog::getUiImpl ( ) const

References myUiImpl.

void DtRtiNetworkComponentViewDialog::keyPressEvent ( QKeyEvent *  event) [virtual, slot]

Handles key press events.

References showHelpDialog().

Handles cleanup of the help dialog after it is closed.

References myHelpAssistant.

Referenced by showHelpDialog().

void DtRtiNetworkComponentViewDialog::processRtiForwarderSelection ( int  index,
bool  ignoreVisibility = false 
) [virtual, slot]

Removes the loading indication messages.

References DtNCVTree::clearConnectionTree(), and myTreeView.

Referenced by clearConnectionTree().

void DtRtiNetworkComponentViewDialog::removeRtiForwarder ( const MAKRti::DtString &  name) [virtual]

Emitted when the full rtiexec log has been requested.

Referenced by connectSignals().

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

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

References DtRtiConnectionInfo::invalidConn(), myRtiForwarderComboBox, and myRtiForwarderConnsByName.

If there is a currently selected RTI Forwarder, return its index.

References myRtiForwarderComboBox.

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

Changes the state of whether the given forwarder connection is being used by a local component.

References myRtiForwarderComboBox.

Referenced by DtAssistantNetworkCompViewMgr::processForwarderConnUpdated().

void DtRtiNetworkComponentViewDialog::showContextMenu ( const QPoint &  pos) [virtual, slot]

Shows the context menu at the given position.

References myContextMenu.

Referenced by connectSignals().

void DtRtiNetworkComponentViewDialog::showEvent ( QShowEvent *  event) [virtual, slot]

Override Qwidget's show function so we can display the correct forwarder.

References clearData(), myLastViewedForwarder, myRtiForwarderComboBox, and processRtiForwarderSelection().

Shows the help dialog.

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

Referenced by connectSignals(), and keyPressEvent().

void DtRtiNetworkComponentViewDialog::showPopup ( const MAKRti::DtString &  ,
const MAKRti::DtString &  ,
const MAKRti::DtString &   
) [signal]

Emitted when a popup dialog from a remote rtiexec should be displayed.

Processes a command to shutdown the current rtiexec.

References shutdownRtiexec().

Referenced by setupUI().

Processes a command to shutdown the current RTI Forwarder.

References shutdownForwarder().

Referenced by setupUI().

Emitted when the currently viewed RTI Forwarder should be shutdown.

Referenced by shutdownCurrentRtiForwarder().

Emitted when the currently viewed rtiexec should be shutdown.

Referenced by shutdownCurrentRtiexec().

Performs periodic functions.

Referenced by DtAssistantNetworkCompViewMgr::tick().

void DtRtiNetworkComponentViewDialog::updateNotifyLevel ( MAKRti::DtNotifyLevelType  level) [virtual]

Emitted when the user chooses to update the RTI Forwarder should be viewed.

Referenced by processRtiForwarderSelection().

void DtRtiNetworkComponentViewDialog::writeToConsole ( const char *  text,
MAKRti::DtNotifyLevelType  notifyLevel 
) [virtual]

Member Data Documentation

File menu.

Referenced by connectSignals(), and setupMenus().

File menu.

Referenced by setupUI().

File menu.

Referenced by setupUI().

Referenced by setupUI().

File menu.

Referenced by connectSignals(), and setupMenus().

Referenced by setupUI().

Component tree column view menu.

Referenced by setupMenus().

Console display menu action.

Referenced by setupMenus().

Referenced by saveGuiState(), setupMenus(), and setupUI().

Console widget and its dock widget.

Referenced by clearConsole(), connectSignals(), consoleTextSize(), setupUI(), updateNotifyLevel(), and writeToConsole().

File menu.

Referenced by setupMenus(), and showContextMenu().

File menu.

File menu.

Referenced by setupUI().

QTreeWidgetItem* DtRtiNetworkComponentViewDialog::myExecItem [protected]

File menu.

Configuration information.

Referenced by DtRtiNetworkComponentViewDialog(), saveGuiState(), and setupUI().

File menu.

Referenced by setupUI().

Help menu.

Referenced by connectSignals(), and setupMenus().

File menu.

Referenced by setupUI().

File menu.

Referenced by clearData(), setupUI(), and setViewedConnectionDescription().

Name of forwarder connection shown last time dialog was displayed.

Referenced by processRtiForwarderSelection(), removeRtiForwarder(), and showEvent().

Item that indicates network component information is being loaded.

File menu.

Referenced by setupUI().

Referenced by setupUI().

Referenced by setupUI().

File menu.

Referenced by setupUI().

Referenced by setupUI().

File menu.

File menu.

Referenced by setupUI().

Ui::NetworkComponentViewDialog DtRtiNetworkComponentViewDialog::myUiImpl [protected]

The actual host name being viewed, not the one that was potentially edited for display in the host label on the GUI.

Referenced by clearData(), setViewedConnectionDescription(), and viewedConnectionDescription().

Referenced by setupUI().

Referenced by setupUI().

const QString DtRtiNetworkComponentViewDialog::theLoadingText [static, protected]

Text displayed when loading network component information.

QString DtRtiNetworkComponentViewDialog::theNoConnectionsAvailableText = tr("No known connections available") [static, protected]

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

Referenced by addRtiForwarder(), removeRtiForwarder(), and setupUI().


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)