MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtAssistantConnConfigWidget Class Reference

Widget that can be brought up by the user to configure their RTI config preferences. More...

+ Inheritance diagram for DtAssistantConnConfigWidget:
+ Collaboration diagram for DtAssistantConnConfigWidget:

Public Slots

void enableOrDisablePrefAccept ()
 Determines whether or not the preference dialog accept button should be enabled or disabled.
- Public Slots inherited from DtAssistantLrcConnQueryWidget
void processStartRtiexec ()
 Processes the pressing of the start rtiexec button by the user.
void cancelStartAndConnect ()
 Processes a cancel from progress dialog for starting and connecting to an rtiexec.
- Public Slots inherited from DtAssistantConnQueryWidget
virtual void processAdd ()
 Processes the pressing of the add connection button by the user.
virtual void processRemove ()
 Processes the pressing of the remove connection button by the user.
virtual void processEdit ()
 Processes the pressing of the edit connection button by the user.
virtual void processSelectionChange (QTreeWidgetItem *item=0)
 Processes a selection change.
virtual void showContextMenu (const QPoint &)
 Shows the context menu at the given location.

Public Member Functions

 DtAssistantConnConfigWidget (QWidget *parent, Qt::WindowFlags f=0)
 Constructor.
virtual ~DtAssistantConnConfigWidget ()
 Destructor.
- Public Member Functions inherited from DtAssistantLrcConnQueryWidget
 DtAssistantLrcConnQueryWidget (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructor.
virtual ~DtAssistantLrcConnQueryWidget ()
 Destructor.
virtual void addKnownAssistant (const DtAssistantInfo &assistant)
 Adds an assistant to the list of known remote assistants.
virtual void removeKnownAssistant (const DtAssistantInfo &assistant)
 Removes an assistant to the list of known remote assistants.
virtual const DtAssistantInfoSetknownAssistants () const
virtual void displayErrorText (bool error)
 Set the variation of widget text based on whether or not it is being displayed due to an error.
virtual void setStartRtiexecEnabled (bool enable, const QString &reason)
 Sets whether or not the "Start rtiexec" button is enabled.
virtual bool acceptCurrentSelection ()
 Processes acceptance of the current selection, starting an rtiexec if necessary and possible.
- Public Member Functions inherited from DtAssistantConnQueryWidget
 DtAssistantConnQueryWidget (QWidget *parent, Qt::WindowFlags f=0)
 Constructor.
virtual ~DtAssistantConnQueryWidget ()
 Destructor.
virtual void useButtonsInsteadOfCheckBox (bool useButtons)
 Configure the widget to use radio buttons rather than a check box to set/unset the whether to use the chosen connection in the future.
virtual void showStartRtiexecButton (bool show)
 Configure the widget to show the start rtiexec button.
virtual void setConnections (const DtRtiConnectionAndConfiguration &conns, bool preserveSelection)
 Sets the list of connections.
virtual void addConnections (const DtRtiConnectionAndConfiguration &conns)
 Adds a set of available connections to the list.
virtual void removeConnections (const DtRtiConnectionAndConfiguration &conns)
 Removes a set of available connections from the list.
virtual void getResults (DtRtiConnectionInfoDataPair &conn, DtRtiConnectionConfigurationInfo &config, bool &choose) const
 Fills in the current chosen connection information settings.
virtual const
DtRtiConnectionAndConfiguration
userAddedConnections ()
 Returns the set of user added connections during this execution of the dialog.
virtual const
DtRtiConnectionAndConfiguration
userRemovedConnections ()
 Returns the set of user removed connections during this execution of the dialog.
virtual void clearUserAddedAndRemoved ()
 Clears all connections added and removed by the user during this execution of the dialog.
virtual bool selectConnection (const DtRtiConnectionInfo &conn)
 Sets which connection should be selected.
virtual void reselectConnection ()
 Unselects and reselects the specified connection to update the state of the current buttons and dialog options.
virtual void getSelectedConnection (DtRtiConnectionInfo &conn) const
 Get the currently selected connection.
virtual void getSelectedConfiguration (DtRtiConnectionConfigurationInfo &config) const
 Get the currently selected configuration.
virtual void addProhibitedPort (int port, const QString &reason)
 Add a port which is prohibited, along with a reason.
virtual void removeProhibitedPort (int port)
 Remove a port which is prohibited.
virtual void setInitialState (bool check)
 Set the initial state of the dialog when it is shown for the very first time.
virtual bool isConnectionNameInUse (const QString &name) const
 Returns true if the given connection name is already in use by a known connection.
virtual bool checkForPortConflicts (int port1, int port2=0)
 Check if the port is prohibited and display an error if it is.
virtual bool checkForValidAddr (const QString &addrStr, const MAKRti::DtInetAddr &ifAddr, MAKRti::DtInetAddr &addr)
 Check if the string is a valid address, as well as valid for the specified interface.
virtual bool checkForConnNameConflict (const QString &name)
 Check if the new connection name is unique.
virtual bool checkForDuplicateConn (const DtRtiConnectionInfo &conn)
 Check if the given connection is a duplicate of an existing connection.
- Public Member Functions inherited from DtAssistantConfigWidget
 DtAssistantConfigWidget (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructor.
virtual ~DtAssistantConfigWidget ()
 Destructor.
virtual QString reasonForDisabledAccept () const
 If the widget has disabled the accept button, returns the reason why.

Protected Member Functions

virtual void updateDisplayedConnection (const QString &name, const DtRtiConnectionInfoDataPair &updatedConn, QTreeWidgetItem *connItem)
 Depending on the type of our current query connection, we update connItem based on updatedConn.
virtual void showEvent (QShowEvent *event)
 Prepare the widget to be shown.
virtual void clearAllConnections ()
 Clears the entire connection list.
virtual void setAcceptEnabled (bool enabled, const QString &reasonForDisable)
 Sets whether or not accept is enabled.
- Protected Member Functions inherited from DtAssistantLrcConnQueryWidget
virtual bool addConnection (const DtRtiConnectionInfoDataPair &conn, const DtRtiConfigurationInfoDataPair &config, DtNameToConnInfoMap::iterator &connIter)
 Adds an available connection to the list.
virtual void removeConnection (const DtRtiConnectionInfoDataPair &conn)
 Removes an available connection from the list.
virtual QTreeWidgetItemfindConnInTree (const DtRtiConnectionInfo &conn, DtNameToConnInfoMap::iterator &connIter)
 Finds the connection item in the tree.
virtual void getConnStatusText (const QTreeWidgetItem *item, const DtRtiConnectionInfoDataPair &conn, const DtRtiConfigurationInfoDataPair &, QString &text)
 Gets the connection status text for the given connection.
virtual void loadLocalInterfaceList ()
 Reloads the list of local interfaces which can be selected for new connections.
virtual bool isKnownAssistant (const DtRtiConnectionInfo &conn)
 Determine if this connection is an rtiexec connection on the same host as one of the known assistants.
virtual bool checkForValidAddrAndHost (const QString &addrStr, const MAKRti::DtInetAddr &ifAddr, MAKRti::DtInetAddr &addr, MAKRti::DtString &hostName)
 Check if the string is a valid address, as well as valid for the specified interface.
virtual void setHostNameFromKnownAssistants (const MAKRti::DtInetAddr &ip, const MAKRti::DtInetAddr &interfaceAddr, MAKRti::DtString &hostName)
 Attempts to set the host name of the connection by matching the IP address and network interface address with a known assistant.
virtual bool setReliableIpFromKnownAssistants (const MAKRti::DtString &hostName, const MAKRti::DtInetAddr &interfaceAddr, MAKRti::DtInetAddr &ip)
 Attempts to set the reliable IP address of the connection by matching the host name and network interface address with a known assistant.
virtual bool promptUserForNewConnInfo (DtRtiConnectionInfoDataPair &conn)
 Prompts the user for new connection info.
virtual bool promptUserToEditConnInfo (DtRtiConnectionInfoDataPair &conn)
 Prompts the user to edit connection info.
virtual bool promptUserForConnInfo (DtRtiConnectionInfoDataPair &conn, const QString &dialogTitle, bool useNameOfGivenConn)
 Prompts the user for connection info.
virtual void setAcceptEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn)
 Enables or disables the accept button based on the state of the given currently selected connection.
virtual void updateDialogBasedOnConn (const DtRtiConnectionInfoDataPair *conn, const DtRtiConfigurationInfoDataPair *config, bool isDisabled)
 Updates the LRC connection query dialog specific items based on the state of the given currently selected connection and configuration.
- Protected Member Functions inherited from DtAssistantConnQueryWidget
virtual bool addConnection (const DtRtiConnectionInfoDataPair &conn, const DtRtiConfigurationInfoDataPair &config, DtNameToConnInfoMap::iterator &connIter)=0
 Adds an available connection to the list.
virtual void storeUserAddedConnection (const DtRtiConnectionInfoDataPair &conn)
 Store information on a connection that user requested to add.
virtual void storeUserRemovedConnection (const DtRtiConnectionInfoDataPair &conn)
 Store information on a connection that user requested to remove.
virtual QTreeWidgetItemfindConnInTree (const DtRtiConnectionInfo &conn, DtNameToConnInfoMap::iterator &connIter)=0
 Finds the connection item in the tree.
virtual void setConnItemToolTip (QTreeWidgetItem *item, const DtRtiConnectionInfoDataPair &conn=std::make_pair(DtRtiConnectionInfo::invalidConn(), DtRtiAssociatedConnectionData()), const DtRtiConfigurationInfoDataPair &config=DtRtiConfigurationInfoDataPair())
 Set the tool tip for the given item.
virtual void setFullyCompliantStateBasedOnConn (const DtRtiConnectionInfoDataPair *conn, const DtRtiConfigurationInfoDataPair *config)
 Enables or disables and sets the fully compliant check box based on the state of the given currently selected connection and configuration.
virtual void setRemoveEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn)
 Enables or disables the remove button based on the state of the given currently selected connection.
virtual void setEditEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn)
 Enables or disables the edit button based on the state of the given currently selected connection.
virtual void disableItem (QTreeWidgetItem *item, bool disable)
 Marks the item as disabled.
virtual bool isItemDisabled (const QTreeWidgetItem *item) const
 Returns true if the item is marked as disabled.
virtual QString reserveNameForConnection (const DtRtiConnectionInfoDataPair &conn)
 Reserves the name for the given connection.
virtual void unreserveNameForConnection (const DtRtiConnectionInfoDataPair &conn)
 Unreserves the given connection name.
bool isAddressNotation (const QString &addrString) const
 Checks if the given string contains an address notation.

Protected Attributes

bool mySelectionIsAcceptable
 Whether or not the current selection is acceptable.
QString myReasonWhyNotAcceptable
 Reason why the selection is not acceptable.
unsigned myPerformReset
 Flag to determine whether or not display should be reset on show event.
QIcon myVerifiedIcon
 Icons.
QIcon myForwarderVerifiedIcon
 Icons.
QIcon myUnknownIcon
 Icons.
QIcon myConflictingIcon
 Icons.
- Protected Attributes inherited from DtAssistantLrcConnQueryWidget
DtAssistantInfoSet myRemoteAssistants
 The set of known remote assistants.
DtAssistantAddLrcConnDialogmyAddConnDialog
 Dialog used to set information for a new connection.
QTreeWidgetItemmyLightweightItem
 Top level item for the lightweight connection type.
QTreeWidgetItemmyRtiexecItem
 Top level item for the rtiexec connection type.
QProgressDialog * myStartAndConnectProgressDlg
 A dialog to display progress when starting and connecting to an rtiexec.
DtRtiConnectionInfo myPendingRtiexecConn
 The rtiexec connection we are attempting to start and connect to.
- Protected Attributes inherited from DtAssistantConnQueryWidget
DtNameToConnInfoMap::iterator myIter
Ui::AssistantConnQueryWidget myUiImpl
DtNameToConnInfoMap myConnectionInfo
 The map of connection entries to detailed connection info.
DtRtiConnectionAndConfiguration myAddedConnections
 Set of added connections.
DtRtiConnectionAndConfiguration myRemovedConnections
 Set of added connections.
DtNameToConnInfoMap::iterator myPredefinedLightweightConnection
 The predefined lightweight connection.
DtNameToConnInfoMap::iterator myPredefinedRtiexecConnection
 The predefined rtiexec connection.
DtNameToConnInfoMap::iterator myChosenConnection
 The connection chosen to be used without prompting.
std::map< int, QString > myProhibitedPorts
 List of prohibited ports and reasons why.
QMenu * myContextMenu
 Context Menu.
bool myContextMenuEnabled
 Controls whether the context menu should be displayed on right clicks.
bool myShowStartRtiexecButton
 Whether the start rtiexec button is displayed.
bool myUseButtonsInsteadOfCheckBox
 Whether the radio buttons are used instead of the check box to set the selected connection to be used automatically in the future.
bool myInitialState
 The dialog is being displayed for the first time ever and should be in its default initial state.
QAction * myAddConnectionAction
 Context menu actions.
QAction * myRemoveConnectionAction
 Context menu actions.
QAction * myEditConnectionAction
 Context menu actions.
QAction * myStartRtiexecAction
 Context menu actions.
QIcon myValidChoiceIcon
 Icons.
QIcon myUnknownChoiceIcon
 Icons.
QIcon myInvalidChoiceIcon
 Icons.

Private Member Functions

 DtAssistantConnConfigWidget (DtAssistantConnConfigWidget const &)
 Copy constructor not implemented.
DtAssistantConnConfigWidgetoperator= (DtAssistantConnConfigWidget const &)
 Assignment operator not implemented.

Additional Inherited Members

- Signals inherited from DtAssistantLrcConnQueryWidget
void startRtiexec (const DtRtiConnectionInfoDataPair &conn, const DtRtiConnectionConfigurationInfo &config, bool isRemote)
 Signal emitted when user chooses to start an rtiexec.
void updateWindowTitle (const QString &)
 Signal emitted when the window title should be changed.
void requestStartRtiexecEnable (const DtRtiConnectionInfoDataPair &)
 Signal emitted when we think we may want to enable the "Start rtiexec" option, but need to be told if its ok (could be disabled by remote assistant for this connection)
- Protected Types inherited from DtAssistantConnQueryWidget
enum  DtConnQueryCol { ConnectionNameCol, StatusCol, SortCol }
typedef std::map< QString,
DtRtiConnAndAssociatedConfig
DtNameToConnInfoMap
- Static Protected Attributes inherited from DtAssistantLrcConnQueryWidget
static const QString theErrorText
 Text to be displayed when there was a connection error.
static const QString theNormalText
 Text to be displayed when there was no error.
static const QString theErrorTitle
 Title to be displayed when there was a connection error.
static const QString theNormalTitle
 Title to be displayed when there was no error.
static const QString theVerifiedText
 Text descriptions for each possible connection status.
static const QString theVerifiedForwarderText
 Text descriptions for each possible connection status.
static const QString theUnknownText
 Text descriptions for each possible connection status.
static const QString theConflictingText
 Text descriptions for each possible connection status.
static const QString theUnknownNetworkInterfaceText
 Text descriptions for each possible connection status.
static const QString theNoNetworkInterfaceText
 Text descriptions for each possible connection status.
static const QString theLightweightBranchHeaderText
 Connection tree branch headers and tool tips.
static const QString theLightweightBranchToolTipText
 Connection tree branch headers and tool tips.
static const QString theRtiexecBranchHeaderText
 Connection tree branch headers and tool tips.
static const QString theRtiexecBranchToolTipText
 Connection tree branch headers and tool tips.

Detailed Description

Widget that can be brought up by the user to configure their RTI config preferences.

Constructor & Destructor Documentation

DtAssistantConnConfigWidget::DtAssistantConnConfigWidget ( QWidget parent,
Qt::WindowFlags  f = 0 
)
DtAssistantConnConfigWidget::~DtAssistantConnConfigWidget ( )
virtual

Destructor.

DtAssistantConnConfigWidget::DtAssistantConnConfigWidget ( DtAssistantConnConfigWidget const &  )
private

Copy constructor not implemented.

Member Function Documentation

void DtAssistantConnConfigWidget::clearAllConnections ( )
protectedvirtual

Clears the entire connection list.

Reimplemented from DtAssistantLrcConnQueryWidget.

References myPerformReset.

void DtAssistantConnConfigWidget::enableOrDisablePrefAccept ( )
slot

Determines whether or not the preference dialog accept button should be enabled or disabled.

References myReasonWhyNotAcceptable, mySelectionIsAcceptable, DtAssistantConnQueryWidget::myUiImpl, and setAcceptEnabled().

Referenced by DtAssistantConnConfigWidget(), and setAcceptEnabled().

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

Assignment operator not implemented.

void DtAssistantConnConfigWidget::setAcceptEnabled ( bool  enabled,
const QString &  reasonForDisable 
)
protectedvirtual

Sets whether or not accept is enabled.

Reimplemented from DtAssistantConnQueryWidget.

References enableOrDisablePrefAccept(), myReasonWhyNotAcceptable, and mySelectionIsAcceptable.

Referenced by enableOrDisablePrefAccept().

void DtAssistantConnConfigWidget::showEvent ( QShowEvent *  event)
protectedvirtual
void DtAssistantConnConfigWidget::updateDisplayedConnection ( const QString &  name,
const DtRtiConnectionInfoDataPair updatedConn,
QTreeWidgetItem connItem 
)
protectedvirtual

Member Data Documentation

QIcon DtAssistantConnConfigWidget::myConflictingIcon
protected
QIcon DtAssistantConnConfigWidget::myForwarderVerifiedIcon
protected
unsigned DtAssistantConnConfigWidget::myPerformReset
protected

Flag to determine whether or not display should be reset on show event.

Referenced by clearAllConnections(), and showEvent().

QString DtAssistantConnConfigWidget::myReasonWhyNotAcceptable
protected

Reason why the selection is not acceptable.

Referenced by enableOrDisablePrefAccept(), and setAcceptEnabled().

bool DtAssistantConnConfigWidget::mySelectionIsAcceptable
protected

Whether or not the current selection is acceptable.

Referenced by enableOrDisablePrefAccept(), and setAcceptEnabled().

QIcon DtAssistantConnConfigWidget::myUnknownIcon
protected
QIcon DtAssistantConnConfigWidget::myVerifiedIcon
protected

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

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)