DtAssistantConfig Class Reference

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_BOOL_PARAMETER (sendForeignQuery, setSendForeignQuery) DtDECLARE_UINT_PARAMETER(latencyTestInteractionPeriodMs
setKeepAlive setLatencyTestInteractionPeriodMs	DtDECLARE_UINT_PARAMETER (latencyTestNumInteractions, setLatencyTestNumInteractions) DtDECLARE_UINT_PARAMETER(latencyTestPayloadBytes
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes	DtDECLARE_BOOL_PARAMETER (displayPopupsAsNotifications, setDisplayPopupsAsNotifications) DtDECLARE_BOOL_PARAMETER(enableNotifications
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications	DtDECLARE_UINT_PARAMETER (lightweightMemorySec, setLightweightMemorySec) DtDECLARE_UINT_PARAMETER(assistantUpdateIntervalSec
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec	DtDECLARE_UINT_PARAMETER (lrcNetStatsUpdateIntervalSec, setLrcNetStatsUpdateIntervalSec) DtDECLARE_FLOAT_PARAMETER(defunctFederateRemovalTimeSec
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec	DtDECLARE_BOOL_PARAMETER (showRtiexecStartupPrompt, setShowRtiexecStartupPrompt) DtDECLARE_BOOL_PARAMETER(acceptRemoteCommands
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec setAcceptRemoteCommands	DtDECLARE_BOOL_PARAMETER (assistantPersistent, setAssistantPersistent) DtDECLARE_BOOL_PARAMETER(defaultToUnlicensed
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec setAcceptRemoteCommands setDefaultToUnlicensed	DtDECLARE_FLOAT_PARAMETER (warningTickInterval, setWarningTickInterval) DtDECLARE_BOOL_PARAMETER(displayRemoteNotifications
setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec setAcceptRemoteCommands setDefaultToUnlicensed setDisplayRemoteNotifications	DtDECLARE_BOOL_PARAMETER (displayFederationColors, setDisplayFederationColors) DtDECLARE_UINT_PARAMETER(federateIdentifier
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.

Protected Member Functions
virtual void	setDefaultConfig ()
	Sets the default configuration.
Protected Member Functions inherited from DtBaseConfig
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.

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

Additional Inherited Members
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.

virtual DtAssistantConfig::~DtAssistantConfig ( )

virtual

Destructor.

DtAssistantConfig::DtAssistantConfig ( const DtAssistantConfig &  )

private

Copy and assignment not allowed.

Member Function Documentation

setKeepAlive DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	sendForeignQuery	,
		setSendForeignQuery
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	displayPopupsAsNotifications	,
		setDisplayPopupsAsNotifications
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	showRtiexecStartupPrompt	,
		setShowRtiexecStartupPrompt
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec setAcceptRemoteCommands DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	assistantPersistent	,
		setAssistantPersistent
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec setAcceptRemoteCommands setDefaultToUnlicensed setDisplayRemoteNotifications DtAssistantConfig::DtDECLARE_BOOL_PARAMETER	(	displayFederationColors	,
		setDisplayFederationColors
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec setDefunctFederateRemovalTimeSec setAcceptRemoteCommands setDefaultToUnlicensed DtAssistantConfig::DtDECLARE_FLOAT_PARAMETER	(	warningTickInterval	,
		setWarningTickInterval
	)

DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	logUpdateInterval	,
		setLogUpdateInterval
	)

setKeepAlive setLatencyTestInteractionPeriodMs DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	latencyTestNumInteractions	,
		setLatencyTestNumInteractions
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	lightweightMemorySec	,
		setLightweightMemorySec
	)

setKeepAlive setLatencyTestInteractionPeriodMs setLatencyTestPayloadBytes setEnableNotifications setAssistantUpdateIntervalSec DtAssistantConfig::DtDECLARE_UINT_PARAMETER	(	lrcNetStatsUpdateIntervalSec	,
		setLrcNetStatsUpdateIntervalSec
	)

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

private

virtual void DtAssistantConfig::setDefaultConfig ( )

inlineprotectedvirtual

Sets the default configuration.

Implements DtBaseConfig.

---

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

• assistantConfig.h