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:

List of all members.

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)
virtual std::vector < DtNCVTreeInfo >	rtiNCVTreeInformation (unsigned int size)
	Vector of tree information.
virtual void	setNCVTreeInformation (std::vector< DtNCVTreeInfo > treeList)
Protected Member Functions
void	setDefaultConfig ()
	Sets the default configuration.
Protected Attributes
std::vector< DtNCVTreeInfo >	myNCVTreeInfo
	the vector of tree information
MAKRti::DtEnvValueSP	myRtiForwarderConsoleVisible
	Pointers to the environment values for each configuration parameter.
Static Protected Attributes
static const bool	theDefaultRtiForwarderConsoleVisible = true
	Default configuration parameter values.
static const MAKRti::DtString	theRtiForwarderConsoleVisibleString = "rtiForwarderConsoleVisible"
	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.

References setDefaultConfig().

DtForwarderConfig::~DtForwarderConfig

(

)

[virtual]

Destructor.

DtForwarderConfig::DtForwarderConfig

(

const DtForwarderConfig &

)

[private]

Copy and assignment not allowed.

---

Member Function Documentation

DtForwarderConfig& DtForwarderConfig::operator=

(

const DtForwarderConfig &

)

[private]

bool DtForwarderConfig::rtiForwarderConsoleVisible

(

)

[virtual]

is the RTI Forwarder Console visible?

References DtBaseConfig::getParam(), myRtiForwarderConsoleVisible, setRtiForwarderConsoleVisible(), theDefaultRtiForwarderConsoleVisible, and theRtiForwarderConsoleVisibleString.

std::vector< DtNCVTreeInfo > DtForwarderConfig::rtiNCVTreeInformation

(

unsigned int

size

)

[virtual]

Vector of tree information.

References DtNCVTreeInfo::columnEnabled, DtNCVTreeInfo::columnIndex, DtBaseConfig::getParam(), and myNCVTreeInfo.

void DtForwarderConfig::setDefaultConfig

(

)

[protected, virtual]

Sets the default configuration.

Implements DtBaseConfig.

References setRtiForwarderConsoleVisible(), and theDefaultRtiForwarderConsoleVisible.

Referenced by DtForwarderConfig().

void DtForwarderConfig::setNCVTreeInformation

(

std::vector< DtNCVTreeInfo >

treeList

)

[virtual]

References myNCVTreeInfo, and DtBaseConfig::setParam().

void DtForwarderConfig::setRtiForwarderConsoleVisible

(

bool

val

)

[virtual]

References myRtiForwarderConsoleVisible, DtBaseConfig::myUpdatedSinceWrite, DtBaseConfig::setParam(), and theRtiForwarderConsoleVisibleString.

Referenced by rtiForwarderConsoleVisible(), and setDefaultConfig().

---

Member Data Documentation

std::vector<DtNCVTreeInfo> DtForwarderConfig::myNCVTreeInfo [protected]

the vector of tree information

Referenced by rtiNCVTreeInformation(), and setNCVTreeInformation().

MAKRti::DtEnvValueSP DtForwarderConfig::myRtiForwarderConsoleVisible [protected]

Pointers to the environment values for each configuration parameter.

Referenced by rtiForwarderConsoleVisible(), and setRtiForwarderConsoleVisible().

const bool DtForwarderConfig::theDefaultRtiForwarderConsoleVisible = true [static, protected]

Default configuration parameter values.

Referenced by rtiForwarderConsoleVisible(), and setDefaultConfig().

const MAKRti::DtString DtForwarderConfig::theRtiForwarderConsoleVisibleString = "rtiForwarderConsoleVisible" [static, protected]

Default configuration parameter values.

Referenced by rtiForwarderConsoleVisible(), and setRtiForwarderConsoleVisible().

---

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

• forwarderConfig.h
• forwarderConfig.cxx