DtForwarderConfig Class Reference

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

Inheritance diagram for DtForwarderConfig:

Collaboration diagram for DtForwarderConfig:

Public Member Functions
	DtForwarderConfig (const MAKRti::DtFilename &xmlFile)
	Constructor.
virtual	~DtForwarderConfig ()
	Destructor.
virtual bool	rtiForwarderConsoleVisible ()
	is the RTI Forwarder Console visible?
virtual void	setRtiForwarderConsoleVisible (bool val)
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
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.

Protected Attributes
std::vector< DtNCVTreeInfo >	myNCVTreeInfo
	the vector of tree information
MAKRti::DtEnvValueSP	myRtiForwarderConsoleVisible
	Pointers to the environment values for each configuration parameter.
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.

Static Protected Attributes
static const bool	theDefaultRtiForwarderConsoleVisible
	Default configuration parameter values.
static const MAKRti::DtString	theRtiForwarderConsoleVisibleString
	Default configuration parameter values.

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

Detailed Description

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

Constructor & Destructor Documentation

DtForwarderConfig::DtForwarderConfig

(

const MAKRti::DtFilename &

xmlFile

)

Constructor.

Creates an Forwarder 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 DtForwarderConfig::~DtForwarderConfig ( )

virtual

Destructor.

DtForwarderConfig::DtForwarderConfig ( const DtForwarderConfig &  )

private

Copy and assignment not allowed.

Member Function Documentation

DtForwarderConfig& DtForwarderConfig::operator= ( const DtForwarderConfig &  )

private

virtual bool DtForwarderConfig::rtiForwarderConsoleVisible ( )

virtual

is the RTI Forwarder Console visible?

void DtForwarderConfig::setDefaultConfig ( )

protectedvirtual

Sets the default configuration.

Implements DtBaseConfig.

virtual void DtForwarderConfig::setRtiForwarderConsoleVisible ( bool  val )

virtual

Member Data Documentation

std::vector<DtNCVTreeInfo> DtForwarderConfig::myNCVTreeInfo

protected

the vector of tree information

MAKRti::DtEnvValueSP DtForwarderConfig::myRtiForwarderConsoleVisible

protected

Pointers to the environment values for each configuration parameter.

const bool DtForwarderConfig::theDefaultRtiForwarderConsoleVisible

staticprotected

Default configuration parameter values.

const MAKRti::DtString DtForwarderConfig::theRtiForwarderConsoleVisibleString

staticprotected

Default configuration parameter values.

---

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

• forwarderConfig.h