DtAssistantRidConfigInfoMgr Class Reference

Maintains lists of known RTI connections. More...

Inheritance diagram for DtAssistantRidConfigInfoMgr:

Collaboration diagram for DtAssistantRidConfigInfoMgr:

Classes
struct	RidConfigurationStruct

Public Types
typedef std::vector < RidConfigurationStruct >	RidConfigurationList

Public Member Functions
	DtAssistantRidConfigInfoMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, const MAKRti::DtFilename &configDir)
	CTOR.
virtual	~DtAssistantRidConfigInfoMgr ()
	Virtual DTOR.
virtual void	refreshRidList ()
	Refreshes the list of configured RIDs.
virtual const RidConfigurationList &	ridConfigurations () const
	Const access to RID configurations.
virtual MAKRti::DtFilename	ridConfigPath (const MAKRti::DtString &configName="") const
	Generates the corresponding RID path for the configuration with the given name.
virtual DtRIDParameters	loadRidConfiguration (const MAKRti::DtString &configurationName, bool isPreconfigured, bool *status=0) const
	Load the given configuration as a lisp string.
virtual bool	saveConfiguration (const MAKRti::DtString &configName, const DtRIDParameters &ridParams)
	Save the given RID configuration.
virtual bool	saveConfiguration (const MAKRti::DtString &configName, const MAKRti::DtString &ridLisp)
	Save the given RID configuration.
virtual bool	renameConfiguration (const MAKRti::DtString &oldConfigName, const MAKRti::DtString &newConfigName)
	Rename the given RID configuration.
virtual bool	deleteConfiguration (const MAKRti::DtString &configName)
	Delete the given RID configuration.
Public Member Functions inherited from DtAssistantMgr
	DtAssistantMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
	Constructor.
virtual	~DtAssistantMgr ()
	Destructor.
virtual void	tick ()
	Performs tasks that need to be completed periodically.
virtual void	startShutdown ()
	Performs any necessary processing at the start of shutdown.
virtual bool	dialogsVisible () const
	Determines if there are any visible dialogs for which this manager is responsible.
virtual void	configWidget (DtAssistantConfigWidget **widget, QIcon &icon, QString &name, DtPreferencesPage &pageId)
	Retrieves a widget which will be placed in the configuration dialog for configuring user preferences.
virtual void	updateConfigWidget ()
	Forces the configuration widget to be updated.
virtual void	processConfigWidgetAccept ()
	Process the changes that were accepted in the configuration widget.

Protected Member Functions
virtual void	initialize ()
	Initializes this manager just prior to beginning assistant processing.
virtual void	populateUserRids ()
	Loads user configured RID files from the config directory.
virtual bool	writeRid (const MAKRti::DtString &outfile, const DtRIDParameters &rid)
	Write the RID specified by the given parameters to the given file.
Protected Member Functions inherited from DtAssistantMgr
void	startDialog (QDialog *dlg, bool inTaskbar, bool warningDialog)
	Sets up the given widget as a dialog.
void	finishDialog (QDialog *dlg)
	Should be called prior to deleting any dialog started with startDialog.
void	showDialog (QDialog *dlg)
	Shows the dialog.
void	startMainWindow (QMainWindow *dlg)
	Sets up a main window dialog.
void	finishMainWindow (QMainWindow *dlg)
	Should be called prior to deleting any dialog started with startMainWindow.
void	showMainWindow (QMainWindow *dlg)
	Shows the dialog.
void	showPopup (const MAKRti::DtString &text, int sourceCompId=-1, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and name of the given source component.
void	showPopup (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and source name.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Displays and logs a notification from the given component.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Displays and logs notification with the given component name.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Logs a notification from the given component, does not display.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Logs a notification with the given component name, does not display.
virtual DtAssistantInfo	assistantInfoFromAssistantMsg (const DtAssistantMsg &assistantMsg, DtInetAddrSet *interfaces=0)

Protected Attributes
RidConfigurationList	myRidConfigurations
MAKRti::DtFilename	myConfigDirectory
Protected Attributes inherited from DtAssistantMgr
DtBoost::shared_ptr < DtRtiAssistantServer >	myServer
	The Assistant server from which new messages will arrive from local RTI components.
DtBoost::shared_ptr < DtRtiAssistantPeer >	myPeer
	The Assistant peer which communicates with other Assistants.
std::set< QDialog * >	myUnparentedDialogs
	All unparented dialogs that are created by the GUI should be added to this set.
std::set< QMainWindow * >	myMainWindows
	All main windows that are created by the GUI should be added to this set.
std::set< QDialog * >	myWarningDialogs
	Set of the popup dialogs, either parented or unparented, which, when active, should cause a warning icon to be displayed.

Private Member Functions
	DtAssistantRidConfigInfoMgr (const DtAssistantRidConfigInfoMgr &)
	Copy Constructor not implemented – Copy Not Allowed!
DtAssistantRidConfigInfoMgr &	operator= (const DtAssistantRidConfigInfoMgr &)
	Assignment not implemented – Assignment Not Allowed!

Additional Inherited Members
Public Slots inherited from DtAssistantMgr
void	displayWarningDialogs ()
	Displays all warning dialogs.
Signals inherited from DtAssistantMgr
void	warningDialogDisplayed ()
	Emitted when a warning dialog is displayed.
void	warningDialogDismissed ()
	Emitted when a warning dialog is dismissed.
void	popupRequested (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	popupRequested (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId, bool logOnly)
	Emitted when a notification should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source, bool logOnly)
	Emitted when a notification should be displayed.
Static Protected Attributes inherited from DtAssistantMgr
static QIcon	theRtiIcon
	The icons used by the RTI Assistant.
static QIcon	theSmallRtiIcon
static QIcon	theWebIcon
static QIcon	theNotifyRtiIcon
static QIcon	theWarningRtiIcon
static QIcon	thePreferencesIcon
static QIcon	theAboutIcon
static QIcon	theHelpIcon
static bool	theIconsAreLoaded
	Whether or not the icons have yet been loaded.

Detailed Description

Maintains lists of known RTI connections.

This includes all lightweight and rtiexec, remote and local, active and inactive connections.

Member Typedef Documentation

typedef std::vector<RidConfigurationStruct> DtAssistantRidConfigInfoMgr::RidConfigurationList

Constructor & Destructor Documentation

DtAssistantRidConfigInfoMgr::DtAssistantRidConfigInfoMgr	(	DtBoost::shared_ptr< DtRtiAssistantServer >	server,
		DtBoost::shared_ptr< DtRtiAssistantPeer >	peer,
		DtAssistantSignalRouter &	signalRouter,
		const MAKRti::DtFilename &	configDir
	)

CTOR.

virtual DtAssistantRidConfigInfoMgr::~DtAssistantRidConfigInfoMgr ( )

virtual

Virtual DTOR.

DtAssistantRidConfigInfoMgr::DtAssistantRidConfigInfoMgr ( const DtAssistantRidConfigInfoMgr &  )

private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

virtual bool DtAssistantRidConfigInfoMgr::deleteConfiguration ( const MAKRti::DtString &  configName )

virtual

Delete the given RID configuration.

Returns true if the configuration was successfully deleted.

virtual void DtAssistantRidConfigInfoMgr::initialize ( )

protectedvirtual

Initializes this manager just prior to beginning assistant processing.

Reimplemented from DtAssistantMgr.

virtual DtRIDParameters DtAssistantRidConfigInfoMgr::loadRidConfiguration ( const MAKRti::DtString &  configurationName, bool  isPreconfigured, bool *  status = 0  ) const

virtual

Load the given configuration as a lisp string.

Loads the RID configuration and populates ridLisp with the lisp

DtAssistantRidConfigInfoMgr& DtAssistantRidConfigInfoMgr::operator= ( const DtAssistantRidConfigInfoMgr &  )

private

Assignment not implemented – Assignment Not Allowed!

virtual void DtAssistantRidConfigInfoMgr::populateUserRids ( )

protectedvirtual

Loads user configured RID files from the config directory.

virtual void DtAssistantRidConfigInfoMgr::refreshRidList ( )

virtual

Refreshes the list of configured RIDs.

Builds list from preconfigured and latest user configured RIDs.

virtual bool DtAssistantRidConfigInfoMgr::renameConfiguration ( const MAKRti::DtString &  oldConfigName, const MAKRti::DtString &  newConfigName  )

virtual

Rename the given RID configuration.

Returns true if the configuration was successfully renamed.

virtual MAKRti::DtFilename DtAssistantRidConfigInfoMgr::ridConfigPath ( const MAKRti::DtString &  configName = "" ) const

virtual

Generates the corresponding RID path for the configuration with the given name.

If called with no arguments (or empty string), returns the RID config storage directory.

virtual const RidConfigurationList& DtAssistantRidConfigInfoMgr::ridConfigurations ( ) const

virtual

Const access to RID configurations.

virtual bool DtAssistantRidConfigInfoMgr::saveConfiguration ( const MAKRti::DtString &  configName, const DtRIDParameters &  ridParams  )

virtual

Save the given RID configuration.

Returns true if the configuration was successfully saved.

virtual bool DtAssistantRidConfigInfoMgr::saveConfiguration ( const MAKRti::DtString &  configName, const MAKRti::DtString &  ridLisp  )

virtual

Save the given RID configuration.

Returns true if the configuration was successfully saved.

virtual bool DtAssistantRidConfigInfoMgr::writeRid ( const MAKRti::DtString &  outfile, const DtRIDParameters &  rid  )

protectedvirtual

Write the RID specified by the given parameters to the given file.

Member Data Documentation

MAKRti::DtFilename DtAssistantRidConfigInfoMgr::myConfigDirectory

protected

RidConfigurationList DtAssistantRidConfigInfoMgr::myRidConfigurations

protected

---

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

• ridConfigInfoMgr.h