MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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. More...
 
- Public Slots inherited from DtAssistantLrcConnQueryWidget
void processStartRtiexec ()
 Processes the pressing of the start rtiexec button by the user. More...
 
void cancelStartAndConnect ()
 Processes a cancel from progress dialog for starting and connecting to an rtiexec. More...
 
- Public Slots inherited from DtAssistantConnQueryWidget
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...
 

Public Member Functions

 DtAssistantConnConfigWidget (QWidget *parent, Qt::WindowFlags f=0)
 CTOR. More...
 
virtual ~DtAssistantConnConfigWidget ()
 Virtual DTOR. More...
 
- Public Member Functions inherited from DtAssistantLrcConnQueryWidget
 DtAssistantLrcConnQueryWidget (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructor. More...
 
virtual ~DtAssistantLrcConnQueryWidget ()
 Destructor. More...
 
virtual void displayErrorText (bool error)
 Set the variation of widget text based on whether or not it is being displayed due to an error. More...
 
virtual void setStartRtiexecEnabled (bool enable, const QString &reason)
 Sets whether or not the "Start rtiexec" button is enabled. More...
 
virtual bool acceptCurrentSelection ()
 Processes acceptance of the current selection, starting an rtiexec if necessary and possible. More...
 
virtual void initializeQtToolTips ()
 
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...
 
- Public Member Functions inherited from DtAssistantConnQueryWidget
 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 const DtAssistantInfoSetknownAssistants () 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 DtAssistantInfogetAssistant (const MAKRti::DtInetAddr &ip)
 Get the first known assistant that matches the given IP Returns the matching assistant; otherwise, NULL. More...
 
virtual const DtAssistantInfogetAssistant (const MAKRti::DtString &hostName)
 Get the first known assistant that matches the given host name Returns the matching assistant; otherwise, NULL. 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...
 
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 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. More...
 
virtual void showEvent (QShowEvent *event)
 Prepare the widget to be shown. More...
 
virtual void clearAllConnections ()
 Clears the entire connection list. More...
 
virtual void setRidConfigurations (const DtAssistantRidConfigInfoMgr::RidConfigurationList &connConfig, bool preserveSelection)
 Overridden to remove the 'Edit Configuration' option when displayed in the preferences dialog. More...
 
virtual void setAcceptEnabled (bool enabled, const QString &reasonForDisable)
 Sets whether or not accept is enabled. More...
 
- 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. More...
 
virtual void removeConnection (const DtRtiConnectionInfoDataPair &conn)
 Removes an available connection from the list. More...
 
virtual QTreeWidgetItemfindConnInTree (const DtRtiConnectionInfo &conn, DtNameToConnInfoMap::iterator &connIter)
 Finds the connection item in the tree. More...
 
virtual void getConnStatusText (const QTreeWidgetItem *item, const DtRtiConnectionInfoDataPair &conn, const DtRtiConfigurationInfoDataPair &, QString &text)
 Gets the connection status text for the given connection. More...
 
virtual void evaluateConnections ()
 Evaluates connections for conflicts or invalid configuration. More...
 
virtual bool checkForValidAddrAndHost (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 promptUserForNewConnInfo (DtRtiConnectionInfoDataPair &conn)
 Prompts the user for new connection info. More...
 
virtual bool promptUserToEditConnInfo (DtRtiConnectionInfoDataPair &conn)
 Prompts the user to edit connection info. More...
 
virtual bool promptUserForConnInfo (DtRtiConnectionInfoDataPair &conn, const QString &dialogTitle, bool useNameOfGivenConn)
 Prompts the user for connection info. More...
 
virtual void setAcceptEnabledBasedOnConn (const DtRtiConnectionInfoDataPair *conn)
 Enables or disables the accept 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 LRC connection query dialog specific items based on the state of the given currently selected connection and configuration. More...
 
- Protected Member Functions inherited from DtAssistantConnQueryWidget
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 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 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 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 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 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

bool mySelectionIsAcceptable
 Whether or not the current selection is acceptable. More...
 
QString myReasonWhyNotAcceptable
 Reason why the selection is not acceptable. More...
 
unsigned myPerformReset
 Flag to determine whether or not display should be reset on show event. More...
 
Icons
QIcon myVerifiedIcon
 
QIcon myForwarderVerifiedIcon
 
QIcon myUnknownIcon
 
QIcon myConflictingIcon
 
- Protected Attributes inherited from DtAssistantLrcConnQueryWidget
DtAssistantAddLrcConnDialogmyAddConnDialog
 Dialog used to set information for a new connection. More...
 
QTreeWidgetItemmyLightweightItem
 Top level item for the lightweight connection type. More...
 
QTreeWidgetItemmyRtiexecItem
 Top level item for the rtiexec connection type. More...
 
QProgressDialog * myStartAndConnectProgressDlg
 A dialog to display progress when starting and connecting to an rtiexec. More...
 
DtRtiConnectionInfo myPendingRtiexecConn
 The rtiexec connection we are attempting to start and connect to. More...
 
QString theErrorText
 Text to be displayed when there was a connection error. More...
 
QString theNormalText
 Text to be displayed when there was no error. More...
 
QString theErrorTitle
 Title to be displayed when there was a connection error. More...
 
QString theNormalTitle
 Title to be displayed when there was no error. More...
 
QString theVerifiedText
 Text descriptions for each possible connection status. More...
 
QString theVerifiedForwarderText
 Text descriptions for each possible connection status. More...
 
QString theUnknownText
 Text descriptions for each possible connection status. More...
 
QString theConflictingText
 Text descriptions for each possible connection status. More...
 
QString theUnknownNetworkInterfaceText
 Text descriptions for each possible connection status. More...
 
QString theNoNetworkInterfaceText
 Text descriptions for each possible connection status. More...
 
QString theNoHostText
 Text descriptions for each possible connection status. More...
 
QString theLightweightBranchHeaderText
 Connection tree branch headers and tool tips. More...
 
QString theLightweightBranchToolTipText
 Connection tree branch headers and tool tips. More...
 
QString theRtiexecBranchHeaderText
 Connection tree branch headers and tool tips. More...
 
QString theRtiexecBranchToolTipText
 Connection tree branch headers and tool tips. More...
 
- Protected Attributes inherited from DtAssistantConnQueryWidget
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...
 
QAction * myAddConnectionAction
 
QAction * myRemoveConnectionAction
 
QAction * myEditConnectionAction
 
QAction * myStartRtiexecAction
 
QIcon myValidChoiceIcon
 
QIcon myUnknownChoiceIcon
 
QIcon myInvalidChoiceIcon
 
QIcon myPartialValidIcon
 

Private Member Functions

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

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. More...
 
void updateWindowTitle (const QString &)
 Signal emitted when the window title should be changed. More...
 
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) More...
 
- Signals inherited from DtAssistantConnQueryWidget
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...
 
- Protected Types inherited from DtAssistantConnQueryWidget
enum  DtConnQueryCol { ConnectionNameCol, StatusCol, SortCol }
 
typedef std::map< QString,
DtRtiConnAndAssociatedConfig
DtNameToConnInfoMap
 

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 
)

CTOR.

virtual DtAssistantConnConfigWidget::~DtAssistantConnConfigWidget ( )
virtual

Virtual DTOR.

DtAssistantConnConfigWidget::DtAssistantConnConfigWidget ( const DtAssistantConnConfigWidget )
private

Copy constructor not implemented.

Member Function Documentation

virtual void DtAssistantConnConfigWidget::clearAllConnections ( )
protectedvirtual

Clears the entire connection list.

Reimplemented from DtAssistantLrcConnQueryWidget.

void DtAssistantConnConfigWidget::enableOrDisablePrefAccept ( )
slot

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

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

Assignment operator not implemented.

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

Sets whether or not accept is enabled.

Reimplemented from DtAssistantConnQueryWidget.

virtual void DtAssistantConnConfigWidget::setRidConfigurations ( const DtAssistantRidConfigInfoMgr::RidConfigurationList connConfig,
bool  preserveSelection 
)
protectedvirtual

Overridden to remove the 'Edit Configuration' option when displayed in the preferences dialog.

Reimplemented from DtAssistantConnQueryWidget.

virtual void DtAssistantConnConfigWidget::showEvent ( QShowEvent *  event)
protectedvirtual

Prepare the widget to be shown.

Reimplemented from DtAssistantLrcConnQueryWidget.

virtual void DtAssistantConnConfigWidget::updateDisplayedConnection ( const QString &  name,
const DtRtiConnectionInfoDataPair updatedConn,
QTreeWidgetItem connItem 
)
protectedvirtual

Depending on the type of our current query connection, we update connItem based on updatedConn.

Reimplemented from DtAssistantLrcConnQueryWidget.

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.

QString DtAssistantConnConfigWidget::myReasonWhyNotAcceptable
protected

Reason why the selection is not acceptable.

bool DtAssistantConnConfigWidget::mySelectionIsAcceptable
protected

Whether or not the current selection is acceptable.

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

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

Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)