![]() |
MAK RTIspy API Documentation for HLA Evolved
|
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. More... | |
| virtual void | processRemove () |
| Processes the pressing of the remove connection button by the user. More... | |
| virtual void | processEdit () |
| Processes the pressing of the edit connection button by the user. More... | |
| virtual void | processSelectionChange (QTreeWidgetItem *item=0) |
| Processes a selection change. More... | |
| virtual void | configurationIndexChanged (int index) |
| Processes selection change in the configuration combo box. More... | |
| virtual void | processTcpInterfaceChange (int hostIndex) |
| Process a selection change for the local TCP interface. More... | |
| virtual void | processUdpInterfaceChange (int hostIndex) |
| Process a selection change for the local UDP interface. More... | |
| virtual void | showContextMenu (const QPoint &) |
| Shows the context menu at the given location. More... | |
Signals | |
| void | editRtiConfigurations () |
| Signal emitted when user chooses to edit configurations. More... | |
| void | selectionAccepted () |
| Signal emitted when the selection is accepted. More... | |
| void | acceptEnabled (bool) |
| Signal that the accept button should be enabled/disabled. More... | |
| void | connectionAdded (const DtRtiConnectionInfoDataPair &conn, DtAssistantConnQueryWidget *widget) |
| Signal emitted when a new connection is added by a user (but not yet accepted). More... | |
Signals inherited from DtAssistantConfigWidget | |
| void | enablePrefAccept () |
| Emitted to indicate that the accept button can be enabled. More... | |
| void | disablePrefAccept () |
| Emitted to indicate that the accept button should be disabled. More... | |
Public Member Functions | |
| DtAssistantConnQueryWidget (QWidget *parent, Qt::WindowFlags f=0) | |
| Constructor. More... | |
| virtual | ~DtAssistantConnQueryWidget () |
| Destructor. More... | |
| virtual void | setComponentType (DtAssistantComponentType type, bool internalQuery) |
| Set the component type the dialog is handling. More... | |
| virtual DtAssistantComponentType | componentType () const |
| Get the component type the dialog handled. More... | |
| virtual bool | internalQuery () const |
| Get if this query originated from the Assistant or a component. More... | |
| 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. More... | |
| virtual void | showStartRtiexecButton (bool show) |
| Configure the widget to show the start rtiexec button. More... | |
| virtual void | addKnownAssistant (const DtAssistantInfo &assistant) |
| Adds an assistant to the list of known remote assistants. More... | |
| virtual void | removeKnownAssistant (const DtAssistantInfo &assistant) |
| Removes an assistant to the list of known remote assistants. More... | |
| virtual const DtAssistantInfoSet & | knownAssistants () const |
| The assistants known by this assistant. More... | |
| virtual bool | isKnownAssistant (const DtRtiConnectionInfo &conn) |
| Determine if this connection is an rtiexec connection on the same host as one of the known assistants. More... | |
| virtual const DtAssistantInfo * | getAssistant (const MAKRti::DtInetAddr &ip) |
| Get the first known assistant that matches the given IP Returns the matching assistant; otherwise, NULL. More... | |
| virtual const DtAssistantInfo * | getAssistant (const MAKRti::DtString &hostName) |
| Get the first known assistant that matches the given host name Returns the matching assistant; otherwise, NULL. More... | |
| virtual void | setRidConfigurations (const DtAssistantRidConfigInfoMgr::RidConfigurationList &connConfig, bool preserveSelection) |
| Sets the list of RID configurations. More... | |
| virtual void | setConnections (const DtRtiConnectionAndConfiguration &connConfig, bool preserveSelection) |
| Sets the list of connections. More... | |
| virtual void | addConnections (const DtRtiConnectionAndConfiguration &conns) |
| Adds a set of available connections to the list. More... | |
| virtual void | removeConnections (const DtRtiConnectionAndConfiguration &conns) |
| Removes a set of available connections from the list. More... | |
| virtual void | getResults (DtRtiConnectionInfoDataPair &conn, DtRtiConnectionConfigurationInfo &config, bool &choose) |
| Fills in the current chosen connection information settings. More... | |
| virtual const DtRtiConnectionAndConfiguration & | userAddedConnections () |
| Returns the set of user added connections during this execution of the dialog. More... | |
| virtual const DtRtiConnectionAndConfiguration & | userRemovedConnections () |
| Returns the set of user removed connections during this execution of the dialog. More... | |
| virtual void | clearUserAddedAndRemoved () |
| Clears all connections added and removed by the user during this execution of the dialog. More... | |
| virtual bool | selectConnection (const DtRtiConnectionInfo &conn) |
| Sets which connection should be selected. More... | |
| virtual void | reselectConnection () |
| Unselects and reselects the specified connection to update the state of the current buttons and dialog options. More... | |
| virtual void | setSelectedConfiguration (const DtRtiConnectionConfigurationInfo *config) |
| Populates full compliance checkbox and selected RID configuration per the given configuration. More... | |
| virtual void | setSelectedRtiSetting (const MAKRti::DtString &name, bool isPreconfigured) |
| Selects RTI Setting configuration. More... | |
| virtual void | getSelectedConnection (DtRtiConnectionInfo &conn) const |
| Get the currently selected connection. More... | |
| virtual void | getSelectedConfiguration (DtRtiConnectionConfigurationInfo &config) const |
| Get the currently selected configuration. More... | |
| virtual void | addProhibitedPort (int port, const QString &reason) |
| Add a port which is prohibited, along with a reason. More... | |
| virtual void | removeProhibitedPort (int port) |
| Remove a port which is prohibited. More... | |
| virtual void | setInitialState (bool check) |
| Set the initial state of the dialog when it is shown for the very first time. More... | |
| virtual bool | isConnectionNameInUse (const QString &name) const |
| Returns true if the given connection name is already in use by a known connection. More... | |
| virtual void | getInterfaceList (const DtAssistantInfo &assistant, bool useIPv4, QStringList &interfaceAdddrList) |
| Reloads the list of local network interfaces which can be selected for new connections. More... | |
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. More... | |
| 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. More... | |
| virtual bool | checkForConnNameConflict (const QString &name) |
| Check if the new connection name is unique. More... | |
| virtual bool | checkForDuplicateConn (const DtRtiConnectionInfo &conn) |
| Check if the given connection is a duplicate of an existing connection. More... | |
Public Member Functions inherited from DtAssistantConfigWidget | |
| DtAssistantConfigWidget (QWidget *parent=0, Qt::WindowFlags f=0) | |
| Constructor. More... | |
| virtual | ~DtAssistantConfigWidget () |
| Destructor. More... | |
| virtual QString | reasonForDisabledAccept () const |
| If the widget has disabled the accept button, returns the reason why. More... | |
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. More... | |
| virtual void | removeConnection (const DtRtiConnectionInfoDataPair &conn)=0 |
| Removes an available connection from the list. More... | |
| virtual bool | replaceConnection (const DtRtiConnAndAssociatedConfig &oldConn, DtRtiConnectionInfoDataPair &newConn, DtNameToConnInfoMap::iterator &connIter) |
| Replace a connection on the list and pass back the iterator of the new item. More... | |
| virtual void | refreshConnections (const DtAssistantInfo &assistant, bool isConnected) |
| Refresh the list of connections with the connection status of the given assistant. More... | |
| virtual void | clearAllConnections ()=0 |
| Clears the entire connection list. More... | |
| virtual void | storeUserAddedConnection (const DtRtiConnectionInfoDataPair &conn) |
| Store information on a connection that user requested to add. More... | |
| virtual void | storeUserRemovedConnection (const DtRtiConnectionInfoDataPair &conn) |
| Store information on a connection that user requested to remove. More... | |
| virtual QTreeWidgetItem * | findConnInTree (const DtRtiConnectionInfo &conn, DtNameToConnInfoMap::iterator &connIter)=0 |
| Finds the connection item in the tree. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | evaluateConnections ()=0 |
| Evaluates connections for conflicts or invalid configuration. More... | |
| virtual bool | promptUserForNewConnInfo (DtRtiConnectionInfoDataPair &conn)=0 |
| Prompts the user for new connection info. More... | |
| virtual bool | promptUserToEditConnInfo (DtRtiConnectionInfoDataPair &conn)=0 |
| Prompts the user to edit connection info. More... | |
| virtual void | setAcceptEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn)=0 |
| Enables or disables the accept button based on the state of the given currently selected connection. More... | |
| 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. More... | |
| virtual void | setFullyCompliantStateBasedOnConn (const DtRtiConnAndAssociatedConfig *connConfig) |
| Enables or disables and sets the fully compliant check box based on the state of the given currently selected connection and if active, its configuration . More... | |
| virtual void | setRemoveEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn) |
| Enables or disables the remove button based on the state of the given currently selected connection. More... | |
| virtual void | setEditEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn) |
| Enables or disables the edit button based on the state of the given currently selected connection. More... | |
| 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. More... | |
| virtual void | disableItem (QTreeWidgetItem *item, bool disable) |
| Marks the item as disabled. More... | |
| virtual bool | isItemDisabled (const QTreeWidgetItem *item) const |
| Returns true if the item is marked as disabled. More... | |
| virtual QString | reserveNameForConnection (const DtRtiConnectionInfoDataPair &conn) |
| Reserves the name for the given connection. More... | |
| virtual void | unreserveNameForConnection (const DtRtiConnectionInfoDataPair &conn) |
| Unreserves the given connection name. More... | |
| virtual void | setAcceptEnabled (bool enabled, const QString &reasonForDisable) |
| Sets whether or not accept is enabled. More... | |
| virtual bool | isAddressNotation (const QString &addrString) const |
| Checks if the given string contains an address notation. More... | |
| virtual void | setLocalInterfaces (const DtRtiConnectionInfo &connInfo) |
| Initialize local interfaces from connection info. More... | |
Protected Attributes | |
| Ui::AssistantConnQueryWidget | myUiImpl |
| DtAssistantComponentType | myComponentType |
| The type of the current querying component. More... | |
| bool | myInternalQuery |
| Whether the query originated internally or from a component. More... | |
| DtNameToConnInfoMap | myConnectionInfo |
| The map of connection entries to detailed connection info. More... | |
| DtAssistantInfoSet | myRemoteAssistants |
| The set of known remote assistants. More... | |
| DtRtiConnectionAndConfiguration | myAddedConnections |
| Set of added connections. More... | |
| DtRtiConnectionAndConfiguration | myRemovedConnections |
| Set of added connections. More... | |
| DtNameToConnInfoMap::iterator | myPredefinedLightweightConnection |
| The predefined lightweight connection. More... | |
| DtNameToConnInfoMap::iterator | myPredefinedRtiexecConnection |
| The predefined rtiexec connection. More... | |
| DtNameToConnInfoMap::iterator | myChosenConnection |
| The connection chosen to be used without prompting. More... | |
| std::map< int, QString > | myProhibitedPorts |
| List of prohibited ports and reasons why. More... | |
| QMenu * | myContextMenu |
| Context Menu. More... | |
| bool | myContextMenuEnabled |
| Controls whether the context menu should be displayed on right clicks. More... | |
| bool | myShowStartRtiexecButton |
| Whether the start rtiexec button is displayed. More... | |
| 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. More... | |
| bool | myInitialState |
| The dialog is being displayed for the first time ever and should be in its default initial state. More... | |
| bool | myProcessLocalInterfaceSelection |
| Indicates that dialog is being initialized and selections can be ignored. More... | |
| int | myLastSelectedIndex |
| Keeps track of the last selected configuration for restoration when choosing edit. More... | |
| bool | myEditConfigurationsAvailable |
| Indicates if "Edit Configurations..." is the final entry in the RTI Settings combo box. More... | |
Context menu actions | |
| QAction * | myAddConnectionAction |
| QAction * | myRemoveConnectionAction |
| QAction * | myEditConnectionAction |
| QAction * | myStartRtiexecAction |
Icons | |
| QIcon | myValidChoiceIcon |
| QIcon | myUnknownChoiceIcon |
| QIcon | myInvalidChoiceIcon |
| QIcon | myPartialValidIcon |
Private Member Functions | |
| DtAssistantConnQueryWidget (const DtAssistantConnQueryWidget &) | |
| Copy constructor not implemented. More... | |
| DtAssistantConnQueryWidget & | operator= (const DtAssistantConnQueryWidget &) |
| Assignment operator not implemented. More... | |
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.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Adds a set of available connections to the list.
|
virtual |
Adds an assistant to the list of known remote assistants.
Reimplemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
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.
|
virtual |
Get the component type the dialog handled.
|
virtualslot |
Processes selection change in the configuration combo box.
|
signal |
Signal emitted when a new connection is added by a user (but not yet accepted).
|
protectedvirtual |
Marks the item as disabled.
|
signal |
Signal emitted when user chooses to edit configurations.
|
protectedpure virtual |
Evaluates connections for conflicts or invalid configuration.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
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.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Get the first known assistant that matches the given IP Returns the matching assistant; otherwise, NULL.
|
virtual |
Get the first known assistant that matches the given host name Returns the matching assistant; otherwise, NULL.
|
protectedpure virtual |
Gets the connection status text to be used in the tool tip for the given connection.
Implemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Reloads the list of local network interfaces which can be selected for new connections.
|
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.
|
virtual |
Get if this query originated from the Assistant or a component.
|
protectedvirtual |
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.
|
virtual |
Determine if this connection is an rtiexec connection on the same host as one of the known assistants.
|
virtual |
The assistants known by this assistant.
|
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.
|
virtualslot |
Process a selection change for the local TCP interface.
|
virtualslot |
Process a selection change for the local UDP interface.
|
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.
|
protectedvirtual |
Refresh the list of connections with the connection status of the given assistant.
|
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 |
Removes an assistant to the list of known remote assistants.
Reimplemented in DtAssistantLrcConnQueryWidget, and DtAssistantRtiexecConnQueryWidget.
|
virtual |
Remove a port which is prohibited.
|
protectedvirtual |
Replace a connection on the list and pass back the iterator of the new item.
Returns true if replaced successfully.
|
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 |
Set the component type the dialog is handling.
|
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 if active, its configuration .
|
virtual |
Set the initial state of the dialog when it is shown for the very first time.
|
protectedvirtual |
Initialize local interfaces from connection info.
|
protectedvirtual |
Enables or disables the remove button based on the state of the given currently selected connection.
|
virtual |
Sets the list of RID configurations.
Clears existing configurations and preserves the current selection if preserveSelection is true and the configuration still exists after the update.
Reimplemented in DtAssistantConnConfigWidget.
|
virtual |
Populates full compliance checkbox and selected RID configuration per the given configuration.
|
virtual |
Selects RTI Setting configuration.
|
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 |
|
protected |
Set of added connections.
|
protected |
The connection chosen to be used without prompting.
|
protected |
The type of the current querying component.
|
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 |
Indicates if "Edit Configurations..." is the final entry in the RTI Settings combo box.
|
protected |
|
protected |
The dialog is being displayed for the first time ever and should be in its default initial state.
|
protected |
Whether the query originated internally or from a component.
|
protected |
|
protected |
Keeps track of the last selected configuration for restoration when choosing edit.
|
protected |
|
protected |
The predefined lightweight connection.
|
protected |
The predefined rtiexec connection.
|
protected |
Indicates that dialog is being initialized and selections can be ignored.
|
protected |
List of prohibited ports and reasons why.
|
protected |
The set of known remote assistants.
|
protected |
|
protected |
Set of added connections.
|
protected |
Whether the start rtiexec button is displayed.
|
protected |
|
protected |
|
protected |
|
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 |