DtAssistantRtiexecConnQueryWidget Class Reference

Widget used to request the user to provide new connection parameters when an rtiexec cannot establish an RTI connection. More...

Inheritance diagram for DtAssistantRtiexecConnQueryWidget:

Collaboration diagram for DtAssistantRtiexecConnQueryWidget:

Public Member Functions
	DtAssistantRtiexecConnQueryWidget (QWidget *parent=0, Qt::WindowFlags f=0)
	Constructor.
virtual	~DtAssistantRtiexecConnQueryWidget ()
	Destructor.
virtual void	setQueryMode (DtAssistantComponentType type)
	sets whether the connection query dialog is handling a forwarder connection or an rtiExec connection.
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 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 void	clearAllConnections ()
	Clears the entire connection list.
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 QTreeWidgetItem *	findConnInTree (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 network interfaces which can be selected for new connections.
virtual void	showEvent (QShowEvent *event)
	Prepare the widget to be shown.
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.
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 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	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
DtAssistantAddRtiexecConnDialog *	myAddConnDialog
	Dialog used to set information for a new connection.
DtAssistantComponentType	myCurrentType
	The type of the current querying component (rtiexec or forwarder).
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
	DtAssistantRtiexecConnQueryWidget (DtAssistantRtiexecConnQueryWidget const &)
	Copy constructor not implemented.
DtAssistantRtiexecConnQueryWidget &	operator= (DtAssistantRtiexecConnQueryWidget const &)
	Assignment operator not implemented.

Additional Inherited Members
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.
Signals inherited from DtAssistantConnQueryWidget
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).
Protected Types inherited from DtAssistantConnQueryWidget
enum	DtConnQueryCol { ConnectionNameCol, StatusCol, SortCol }
typedef std::map< QString, DtRtiConnAndAssociatedConfig >	DtNameToConnInfoMap

Detailed Description

Widget used to request the user to provide new connection parameters when an rtiexec cannot establish an RTI connection.

Constructor & Destructor Documentation

DtAssistantRtiexecConnQueryWidget::DtAssistantRtiexecConnQueryWidget	(	QWidget *	parent = 0,
		Qt::WindowFlags	f = 0
	)

Constructor.

virtual DtAssistantRtiexecConnQueryWidget::~DtAssistantRtiexecConnQueryWidget ( )

virtual

Destructor.

DtAssistantRtiexecConnQueryWidget::DtAssistantRtiexecConnQueryWidget ( DtAssistantRtiexecConnQueryWidget const &  )

private

Copy constructor not implemented.

Member Function Documentation

virtual bool DtAssistantRtiexecConnQueryWidget::addConnection ( const DtRtiConnectionInfoDataPair &  conn, const DtRtiConfigurationInfoDataPair &  config, DtNameToConnInfoMap::iterator &  connIter  )

protectedvirtual

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 void DtAssistantRtiexecConnQueryWidget::clearAllConnections ( )

protectedvirtual

Clears the entire connection list.

Implements DtAssistantConnQueryWidget.

virtual QTreeWidgetItem* DtAssistantRtiexecConnQueryWidget::findConnInTree ( const DtRtiConnectionInfo &  conn, DtNameToConnInfoMap::iterator &  connIter  )

protectedvirtual

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.

virtual void DtAssistantRtiexecConnQueryWidget::getConnStatusText ( const QTreeWidgetItem *  item, const DtRtiConnectionInfoDataPair &  conn, const DtRtiConfigurationInfoDataPair &  , QString &  text  )

protectedvirtual

Gets the connection status text for the given connection.

Implements DtAssistantConnQueryWidget.

virtual void DtAssistantRtiexecConnQueryWidget::loadLocalInterfaceList ( )

protectedvirtual

Reloads the list of local network interfaces which can be selected for new connections.

Implements DtAssistantConnQueryWidget.

DtAssistantRtiexecConnQueryWidget& DtAssistantRtiexecConnQueryWidget::operator= ( DtAssistantRtiexecConnQueryWidget const &  )

private

Assignment operator not implemented.

virtual bool DtAssistantRtiexecConnQueryWidget::promptUserForConnInfo ( DtRtiConnectionInfoDataPair &  conn, const QString &  dialogTitle, bool  useNameOfGivenConn  )

protectedvirtual

Prompts the user for connection info.

virtual bool DtAssistantRtiexecConnQueryWidget::promptUserForNewConnInfo ( DtRtiConnectionInfoDataPair &  conn )

protectedvirtual

Prompts the user for new connection info.

Implements DtAssistantConnQueryWidget.

virtual bool DtAssistantRtiexecConnQueryWidget::promptUserToEditConnInfo ( DtRtiConnectionInfoDataPair &  conn )

protectedvirtual

Prompts the user to edit connection info.

Implements DtAssistantConnQueryWidget.

virtual void DtAssistantRtiexecConnQueryWidget::removeConnection ( const DtRtiConnectionInfoDataPair &  conn )

protectedvirtual

Removes an available connection from the list.

Implements DtAssistantConnQueryWidget.

virtual void DtAssistantRtiexecConnQueryWidget::setAcceptEnabledBasedOnConn ( const DtRtiConnectionInfoDataPair *  conn )

protectedvirtual

Enables or disables the accept button based on the state of the given currently selected connection.

Implements DtAssistantConnQueryWidget.

virtual void DtAssistantRtiexecConnQueryWidget::setQueryMode ( DtAssistantComponentType  type )

virtual

sets whether the connection query dialog is handling a forwarder connection or an rtiExec connection.

virtual void DtAssistantRtiexecConnQueryWidget::showEvent ( QShowEvent *  event )

protectedvirtual

Prepare the widget to be shown.

virtual void DtAssistantRtiexecConnQueryWidget::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.

Implements DtAssistantConnQueryWidget.

Member Data Documentation

DtAssistantAddRtiexecConnDialog* DtAssistantRtiexecConnQueryWidget::myAddConnDialog

protected

Dialog used to set information for a new connection.

DtAssistantComponentType DtAssistantRtiexecConnQueryWidget::myCurrentType

protected

The type of the current querying component (rtiexec or forwarder).

---

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

• rtiexecConnQueryWidget.h