icl::utils::ConfigurableProxy Class Reference

This class provides the getter and setter methods of an internally set Configurable. More...

#include <ConfigurableProxy.h>

Inheritance diagram for icl::utils::ConfigurableProxy:

List of all members.

Public Member Functions
virtual	~ConfigurableProxy ()
	virtual destructor
	ConfigurableProxy (Configurable *c=NULL)
	Constructor with passed internal Configurable.
void	setInternalConfigurable (Configurable *c=NULL)
	sets the internally used Configurable to the passed one
Configurable *	getInternalConfigurable () const
	returns the internally used Configurable
void	setPropertyValue (const std::string &propertyName, const Any &value) throw (ICLException)
	sets a property value
std::vector< std::string >	getPropertyList () const
	returns a list of All properties, that can be set using setProperty
bool	supportsProperty (const std::string &propertyName) const
	base implementation for property check (seaches in the property list)
void	saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=Configurable::EMPTY_VEC) const
	writes all available properties into a file
void	loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=Configurable::EMPTY_VEC)
	reads a camera config file from disc
std::string	getPropertyType (const std::string &propertyName) const
	get type of property
std::string	getPropertyInfo (const std::string &propertyName) const
	get information of a properties valid values
Any	getPropertyValue (const std::string &propertyName) const
	returns the current value of a property or a parameter
std::string	getPropertyToolTip (const std::string &propertyName) const
	returns the tooltip description for a given property
int	getPropertyVolatileness (const std::string &propertyName) const
	Returns whether this property may be changed internally.
void	syncChangesTo (Configurable *configurables, int num=1)
	syncronzies all property changes to the given configurable
void	syncChangesTo (ConfigurableProxy *configurable)
	syncronzies all property changes to the given configurable
Private Attributes
Mutex	m_configurableLock
Configurable *	m_intConfigurable

---

Detailed Description

This class provides the getter and setter methods of an internally set Configurable.

---

Constructor & Destructor Documentation

virtual icl::utils::ConfigurableProxy::~ConfigurableProxy

(

)

[inline, virtual]

virtual destructor

icl::utils::ConfigurableProxy::ConfigurableProxy

(

Configurable *

c = NULL

)

[inline]

Constructor with passed internal Configurable.

---

Member Function Documentation

Configurable* icl::utils::ConfigurableProxy::getInternalConfigurable

(

)

const [inline]

returns the internally used Configurable

std::string icl::utils::ConfigurableProxy::getPropertyInfo

(

const std::string &

propertyName

)

const [inline]

get information of a properties valid values

std::vector<std::string> icl::utils::ConfigurableProxy::getPropertyList

(

)

const [inline]

returns a list of All properties, that can be set using setProperty

std::string icl::utils::ConfigurableProxy::getPropertyToolTip

(

const std::string &

propertyName

)

const [inline]

returns the tooltip description for a given property

std::string icl::utils::ConfigurableProxy::getPropertyType

(

const std::string &

propertyName

)

const [inline]

get type of property

Any icl::utils::ConfigurableProxy::getPropertyValue

(

const std::string &

propertyName

)

const [inline]

returns the current value of a property or a parameter

int icl::utils::ConfigurableProxy::getPropertyVolatileness

(

const std::string &

propertyName

)

const [inline]

Returns whether this property may be changed internally.

void icl::utils::ConfigurableProxy::loadProperties	(	const std::string &	filename,
		const std::vector< std::string > &	propertiesToSkip = Configurable::EMPTY_VEC
	)		[inline]

reads a camera config file from disc

void icl::utils::ConfigurableProxy::saveProperties	(	const std::string &	filename,
		const std::vector< std::string > &	propertiesToSkip = Configurable::EMPTY_VEC
	)		const [inline]

writes all available properties into a file

void icl::utils::ConfigurableProxy::setInternalConfigurable

(

Configurable *

c = NULL

)

[inline]

sets the internally used Configurable to the passed one

void icl::utils::ConfigurableProxy::setPropertyValue	(	const std::string &	propertyName,
		const Any &	value
	)		throw (ICLException) [inline]

sets a property value

bool icl::utils::ConfigurableProxy::supportsProperty

(

const std::string &

propertyName

)

const [inline]

base implementation for property check (seaches in the property list)

void icl::utils::ConfigurableProxy::syncChangesTo	(	Configurable *	configurables,
		int	num = 1
	)		[inline]

syncronzies all property changes to the given configurable

void icl::utils::ConfigurableProxy::syncChangesTo

(

ConfigurableProxy *

configurable

)

[inline]

syncronzies all property changes to the given configurable

---

Member Data Documentation

Mutex icl::utils::ConfigurableProxy::m_configurableLock [mutable, private]

Configurable* icl::utils::ConfigurableProxy::m_intConfigurable [private]

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLUtils/src/ICLUtils/ConfigurableProxy.h