makVrv::DtConfiguration Class Reference

The base implementation of a configuration. More...

Inheritance diagram for makVrv::DtConfiguration:

List of all members.

Public Types
typedef std::map< std::string, std::string >	ParameterMap
Public Member Functions
	DtConfiguration (const std::string &name="")
	CTOR.
	DtConfiguration (const DtConfiguration &)
	Copy CTOR.
DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP.
virtual	~DtConfiguration ()
	DTOR.
virtual const std::string &	name () const
	Get the configuration name.
virtual void	setName (const std::string &name)
	Set the configuration name.
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters.
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const ParameterMap &	optionalParameters () const
	Get the optional parameters.
Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.
Protected Attributes
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface

---

Detailed Description

The base implementation of a configuration.

---

Member Typedef Documentation

typedef std::map<std::string,std::string> makVrv::DtConfiguration::ParameterMap

---

Constructor & Destructor Documentation

makVrv::DtConfiguration::DtConfiguration

(

const std::string &

name = ""

)

CTOR.

makVrv::DtConfiguration::DtConfiguration

(

const DtConfiguration &

)

Copy CTOR.

virtual makVrv::DtConfiguration::~DtConfiguration

(

)

[virtual]

DTOR.

---

Member Function Documentation

DtConfiguration& makVrv::DtConfiguration::operator=

(

const DtConfiguration &

)

Assignment OP.

virtual const std::string& makVrv::DtConfiguration::name

(

)

const [virtual]

Get the configuration name.

virtual void makVrv::DtConfiguration::setName

(

const std::string &

name

)

[virtual]

Set the configuration name.

virtual const std::string* makVrv::DtConfiguration::findOptionalParameter

(

const std::string &

name

)

const [virtual]

Find an optional parameters.

virtual void makVrv::DtConfiguration::setOptionalParameter	(	const std::string &	name,
		const std::string &	value
	)		[virtual]

Set an optional parameter.

virtual void makVrv::DtConfiguration::setOptionalParameters

(

const ParameterMap &

)

[virtual]

Set an optional parameters.

This will overwrite any existing optional parameters.

virtual void makVrv::DtConfiguration::removeOptionalParameter

(

const std::string &

name

)

[virtual]

Remove an optional parameter.

const ParameterMap& makVrv::DtConfiguration::optionalParameters

(

)

const

Get the optional parameters.

template<class Archive >

void makVrv::DtConfiguration::_serialize	(	Archive &	ar,
		const unsigned int	version
	)		[inline, protected]

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.

Serialize this class.

Reimplemented in makVrv::DtDeInitializer, makVrv::DtPageConfiguration, makVrv::DtToolbarConfiguration, makVrv::DtChannelConfiguration, makVrv::DtObserverConfiguration, makVrv::DtWindowConfiguration, makVrv::DtDisplayConfiguration, makVrv::DtInputDriverConfiguration, makVrv::DtDriverConfiguration, and makVrv::DtDeConfiguration.

References DT_SERIALIZE_MEMBER.

---

Member Data Documentation

std::string makVrv::DtConfiguration::myName [protected]

ParameterMap makVrv::DtConfiguration::myOptionalParameters [protected]

DtProxyWP makVrv::DtConfiguration::myAttachedInterface [protected]

---

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

• include/vrvUtil/DtConfiguration.h