![]() |
MAK RTIspy API Documentation for HLA 1.3
|
Widget used to request the user to provide new connection parameters when a component cannot establish an RTI connection. More...
Inheritance diagram for DtAssistantConnQueryWidget:
Collaboration diagram for DtAssistantConnQueryWidget:Classes | |
| struct | DtRtiConnAndAssociatedConfig |
Public Slots | |
| 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. | |
Signals | |
| void | selectionAccepted () |
| Signal emitted when the selection is accepted. | |
| void | acceptEnabled (bool) |
| Signal that the accept button should be enabled/disabled. | |
| void | connectionAdded (const DtRtiConnectionInfoDataPair &conn, DtAssistantConnQueryWidget *widget) |
| Signal emitted when a new connection is added by a user (but not yet accepted). | |
Signals inherited from DtAssistantConfigWidget | |
| void | enablePrefAccept () |
| Emitted to indicate that the accept button can be enabled. | |
| void | disablePrefAccept () |
| Emitted to indicate that the accept button should be disabled. | |
Public Member Functions | |
| 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. | |
Check Functions - PASS = return true; FAIL = error dialog, return false | |
| 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 Types | |
| enum | DtConnQueryCol { ConnectionNameCol, StatusCol, SortCol } |
| typedef std::map< QString, DtRtiConnAndAssociatedConfig > | DtNameToConnInfoMap |
Protected Member Functions | |
| virtual bool | addConnection (const DtRtiConnectionInfoDataPair &conn, const DtRtiConfigurationInfoDataPair &config, DtNameToConnInfoMap::iterator &connIter)=0 |
| Adds an available connection to the list. | |
| virtual void | removeConnection (const DtRtiConnectionInfoDataPair &conn)=0 |
| Removes an available connection from the list. | |
| virtual void | clearAllConnections ()=0 |
| Clears the entire connection 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 QTreeWidgetItem * | findConnInTree (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 | getConnStatusText (const QTreeWidgetItem *item, const DtRtiConnectionInfoDataPair &conn, const DtRtiConfigurationInfoDataPair &, QString &text)=0 |
| Gets the connection status text to be used in the tool tip for the given connection. | |
| virtual void | loadLocalInterfaceList ()=0 |
| Reloads the list of local network interfaces which can be selected for new connections. | |
| virtual bool | promptUserForNewConnInfo (DtRtiConnectionInfoDataPair &conn)=0 |
| Prompts the user for new connection info. | |
| virtual bool | promptUserToEditConnInfo (DtRtiConnectionInfoDataPair &conn)=0 |
| Prompts the user to edit connection info. | |
| virtual void | setAcceptEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn)=0 |
| Enables or disables the accept button based on the state of the given currently selected connection. | |
| virtual void | updateDisplayedConnection (const QString &name, const DtRtiConnectionInfoDataPair &updatedConn, QTreeWidgetItem *connItem)=0 |
| Depending on the type of our current query connection, we update connItem based on updatedConn. | |
| 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 | updateDialogBasedOnConn (const DtRtiConnectionInfoDataPair *conn, const DtRtiConfigurationInfoDataPair *config, bool isDisabled) |
| Updates the dialog based on the state of the given currently selected connection and configuration. | |
| 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. | |
| virtual void | setAcceptEnabled (bool enabled, const QString &reasonForDisable) |
| Sets whether or not accept is enabled. | |
| bool | isAddressNotation (const QString &addrString) const |
| Checks if the given string contains an address notation. | |
Protected Attributes | |
| 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 | |
| DtAssistantConnQueryWidget (DtAssistantConnQueryWidget const &) | |
| Copy constructor not implemented. | |
| DtAssistantConnQueryWidget & | operator= (DtAssistantConnQueryWidget const &) |
| Assignment operator not implemented. | |
Widget used to request the user to provide new connection parameters when a component cannot establish an RTI connection.
|
protected |
|
protected |
| DtAssistantConnQueryWidget::DtAssistantConnQueryWidget | ( | QWidget * | parent, |
| Qt::WindowFlags | f = 0 |
||
| ) |
Constructor.
|
virtual |
Destructor.
|
private |
Copy constructor not implemented.
|
signal |
Signal that the accept button should be enabled/disabled.
|
protectedpure virtual |
Adds an available connection to the list.
Returns true if it was successfully added and sets the iterator to location in the map of the new connection.
|
virtual |
Adds a set of available connections to the list.
|
virtual |
Add a port which is prohibited, along with a reason.
|
virtual |
Check if the new connection name is unique.
|
virtual |
Check if the given connection is a duplicate of an existing connection.
|
virtual |
Check if the port is prohibited and display an error if it is.
Checks one or two ports, and will make sure the two do not conflict with each other.
|
virtual |
Check if the string is a valid address, as well as valid for the specified interface.
Return the constructed DtInetAddr.
|
protectedpure virtual |
Clears the entire connection list.
Implemented in DtAssistantLrcConnQueryWidget, DtAssistantRtiexecConnQueryWidget, and DtAssistantConnConfigWidget.
|
virtual |
Clears all connections added and removed by the user during this execution of the dialog.
|
signal |
Signal emitted when a new connection is added by a user (but not yet accepted).
|
protectedvirtual |
Marks the item as disabled.
|
protectedpure virtual |
Finds the connection item in the tree.
Returns a pointer to the tree item as well as an iterator to its location in the map.
|
protectedpure virtual |
Gets the connection status text to be used in the tool tip for the given connection.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Fills in the current chosen connection information settings.
The choose parameter will be set to true if the user selected to set this as the chosen connection for the future in order to avoid further prompts.
|
virtual |
Get the currently selected configuration.
|
virtual |
Get the currently selected connection.
|
protected |
Checks if the given string contains an address notation.
e.g. "192.168.3.226" or "fe80::a8f5:2359:6c86:3890"
|
virtual |
Returns true if the given connection name is already in use by a known connection.
|
protectedvirtual |
Returns true if the item is marked as disabled.
|
protectedpure virtual |
Reloads the list of local network interfaces which can be selected for new connections.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
private |
Assignment operator not implemented.
|
virtualslot |
Processes the pressing of the add connection button by the user.
|
virtualslot |
Processes the pressing of the edit connection button by the user.
|
virtualslot |
Processes the pressing of the remove connection button by the user.
|
virtualslot |
Processes a selection change.
If no item is specified the current selected item will attempt to be found.
|
protectedpure virtual |
Prompts the user for new connection info.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
protectedpure virtual |
Prompts the user to edit connection info.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
protectedpure virtual |
Removes an available connection from the list.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Removes a set of available connections from the list.
|
virtual |
Remove a port which is prohibited.
|
virtual |
Unselects and reselects the specified connection to update the state of the current buttons and dialog options.
|
protectedvirtual |
Reserves the name for the given connection.
Ensures that all connections are listed with unique names in the dialog. Returns the name that should be used for this connection.
|
virtual |
Sets which connection should be selected.
Returns true if connection was found and selected.
|
signal |
Signal emitted when the selection is accepted.
|
protectedvirtual |
Sets whether or not accept is enabled.
Reimplemented from DtAssistantConfigWidget.
Reimplemented in DtAssistantConnConfigWidget.
|
protectedpure virtual |
Enables or disables the accept button based on the state of the given currently selected connection.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Sets the list of connections.
Clears the current list first. Will preserve the current selection if preserveSelection is true and the connection still exists after the update.
|
protectedvirtual |
Set the tool tip for the given item.
If the connection info is not provided it will be looked up.
|
protectedvirtual |
Enables or disables the edit button based on the state of the given currently selected connection.
|
protectedvirtual |
Enables or disables and sets the fully compliant check box based on the state of the given currently selected connection and configuration.
|
virtual |
Set the initial state of the dialog when it is shown for the very first time.
|
protectedvirtual |
Enables or disables the remove button based on the state of the given currently selected connection.
|
virtualslot |
Shows the context menu at the given location.
|
virtual |
Configure the widget to show the start rtiexec button.
|
protectedvirtual |
Store information on a connection that user requested to add.
|
protectedvirtual |
Store information on a connection that user requested to remove.
|
protectedvirtual |
Unreserves the given connection name.
|
inlineprotectedvirtual |
Updates the dialog based on the state of the given currently selected connection and configuration.
Reimplemented in DtAssistantLrcConnQueryWidget.
|
protectedpure virtual |
Depending on the type of our current query connection, we update connItem based on updatedConn.
Implemented in DtAssistantLrcConnQueryWidget, DtAssistantRtiexecConnQueryWidget, and DtAssistantConnConfigWidget.
|
virtual |
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 |
Returns the set of user added connections during this execution of the dialog.
|
virtual |
Returns the set of user removed connections during this execution of the dialog.
|
protected |
Context menu actions.
|
protected |
Set of added connections.
|
protected |
The connection chosen to be used without prompting.
|
protected |
The map of connection entries to detailed connection info.
|
protected |
Context Menu.
|
protected |
Controls whether the context menu should be displayed on right clicks.
|
protected |
Context menu actions.
|
protected |
The dialog is being displayed for the first time ever and should be in its default initial state.
|
protected |
Icons.
|
protected |
|
protected |
The predefined lightweight connection.
|
protected |
The predefined rtiexec connection.
|
protected |
List of prohibited ports and reasons why.
|
protected |
Context menu actions.
|
protected |
Set of added connections.
|
protected |
Whether the start rtiexec button is displayed.
|
protected |
Context menu actions.
|
protected |
|
protected |
Icons.
|
protected |
Whether the radio buttons are used instead of the check box to set the selected connection to be used automatically in the future.
|
protected |
Icons.