Stores the Assistant configuration information and handles saving and loading this information from an XML file. More...

Inheritance diagram for DtAssistantConfig:

Collaboration diagram for DtAssistantConfig:

Public Member Functions
	DtAssistantConfig (const MAKRti::DtFilename &xmlFile)
	Constructor.
virtual	~DtAssistantConfig ()
	Destructor.
	DtDECLARE_UINT_PARAMETER (logUpdateInterval, setLogUpdateInterval) DtDECLARE_BOOL_PARAMETER(keepAlive
setKeepAlive	DtDECLARE_UINT_PARAMETER (latencyTestInteractionPeriodMs, setLatencyTestInteractionPeriodMs) DtDECLARE_UINT_PARAMETER(latencyTestNumInteractions
setKeepAlive setLatencyTestNumInteractions	DtDECLARE_UINT_PARAMETER (latencyTestPayloadBytes, setLatencyTestPayloadBytes) DtDECLARE_BOOL_PARAMETER(displayPopupsAsNotifications
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications	DtDECLARE_BOOL_PARAMETER (enableNotifications, setEnableNotifications) DtDECLARE_UINT_PARAMETER(lightweightMemorySec
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec	DtDECLARE_UINT_PARAMETER (assistantUpdateIntervalSec, setAssistantUpdateIntervalSec) DtDECLARE_UINT_PARAMETER(lrcNetStatsUpdateIntervalSec
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec	DtDECLARE_FLOAT_PARAMETER (defunctFederateRemovalTimeSec, setDefunctFederateRemovalTimeSec) DtDECLARE_BOOL_PARAMETER(showRtiexecStartupPrompt
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt	DtDECLARE_BOOL_PARAMETER (acceptRemoteCommands, setAcceptRemoteCommands) DtDECLARE_BOOL_PARAMETER(assistantPersistent
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt setAssistantPersistent	DtDECLARE_BOOL_PARAMETER (defaultToUnlicensed, setDefaultToUnlicensed) DtDECLARE_FLOAT_PARAMETER(warningTickInterval
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt setAssistantPersistent setWarningTickInterval	DtDECLARE_BOOL_PARAMETER (displayRemoteNotifications, setDisplayRemoteNotifications) DtDECLARE_BOOL_PARAMETER(displayFederationColors
setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt setAssistantPersistent setWarningTickInterval setDisplayFederationColors	DtDECLARE_UINT_PARAMETER (federateIdentifier, setFederateIdentifier) protected
Public Member Functions inherited from DtBaseConfig
	DtBaseConfig (const MAKRti::DtFilename &xmlFile)
	Constructor.
virtual	~DtBaseConfig ()
	Destructor.
virtual void	writeToFile ()
	Writes the configuration to the default XML file specified at creation.
virtual void	writeToFile (const MAKRti::DtFilename &xmlFile)
	Writes the configuration to the specified XML file.
virtual bool	getFileVersion (MAKRti::DtString &version) const
	Returns the RTI version of the file that was read.
virtual bool	isFileVersionOld () const
	is the file read version different than the current version
virtual void	needsUpdate ()
	sets the update flag
virtual std::ostream &	print (std::ostream &ostr) const
	Prints the configuration to the given output stream.

Private Member Functions
	DtAssistantConfig (const DtAssistantConfig &)
	Copy and assignment not allowed.
DtAssistantConfig &	operator= (const DtAssistantConfig &)

Additional Inherited Members
Protected Member Functions inherited from DtBaseConfig
virtual void	setDefaultConfig ()=0
	Sets the default configuration.
MAKRti::DtEnvValueSP	setParam (const MAKRti::DtString &name, const MAKRti::DtString &val, const MAKRti::DtString &comment=MAKRti::DtString::nullString())
	Sets (or adds) the given parameter to the configuration.
MAKRti::DtEnvValueSP	getParam (const MAKRti::DtString &name)
	Gets the parameter with the given name.
Protected Attributes inherited from DtBaseConfig
MAKRti::DtEnvironment	myEnvironment
	The Base configuration environment.
std::auto_ptr < MAKRti::DtEnvXMLWriter >	myXmlWriter
	Document writer - used to convert the document to XML in memory or file myXmlWriter is persistent so that the XML memory buffer does not re-allocate as often.
MAKRti::DtFilename	myXmlFile
	The name of the default XML file to read from and write to.
bool	myUpdatedSinceWrite
	Flag indicating if the environment has changed since the last time it was written to the default file.
MAKRti::DtString	myReadFileVersion
	The version of the file that was read.
bool	myFileWasRead
	Indicates whether a cache file was found and read.

Detailed Description

Stores the Assistant configuration information and handles saving and loading this information from an XML file.

Constructor & Destructor Documentation

DtAssistantConfig::DtAssistantConfig ( const MAKRti::DtFilename & xmlFile )

Constructor.

Creates an Assistant configuration from the given XML file. If the file cannot be found, a default configuration is created. In this case the file name will be saved as the default file if the configuration needs to be written later.

DtAssistantConfig::~DtAssistantConfig ( )

virtual

Destructor.

DtAssistantConfig::DtAssistantConfig ( const DtAssistantConfig & )

private

Copy and assignment not allowed.

Member Function Documentation

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	enableNotifications	,
		setEnableNotifications
	)

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	acceptRemoteCommands	,
		setAcceptRemoteCommands
	)

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt setAssistantPersistent DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	defaultToUnlicensed	,
		setDefaultToUnlicensed
	)

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt setAssistantPersistent setWarningTickInterval DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	displayRemoteNotifications	,
		setDisplayRemoteNotifications
	)

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec DtAssistantConfig::DtDECLARE_FLOAT_PARAMETER	(	defunctFederateRemovalTimeSec	,
		setDefunctFederateRemovalTimeSec
	)

DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	logUpdateInterval	,
		setLogUpdateInterval
	)

setKeepAlive DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	latencyTestInteractionPeriodMs	,
		setLatencyTestInteractionPeriodMs
	)

setKeepAlive setLatencyTestNumInteractions DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	latencyTestPayloadBytes	,
		setLatencyTestPayloadBytes
	)

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	assistantUpdateIntervalSec	,
		setAssistantUpdateIntervalSec
	)

setKeepAlive setLatencyTestNumInteractions setDisplayPopupsAsNotifications setLightweightMemorySec setLrcNetStatsUpdateIntervalSec setShowRtiexecStartupPrompt setAssistantPersistent setWarningTickInterval setDisplayFederationColors DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	federateIdentifier	,
		setFederateIdentifier
	)

inline

DtAssistantConfig& DtAssistantConfig::operator= ( const DtAssistantConfig & )

private

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation