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:

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

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

~ConfigurableProxy()

virtual icl::utils::ConfigurableProxy::~ConfigurableProxy ( )

inlinevirtual

virtual destructor

ConfigurableProxy()

icl::utils::ConfigurableProxy::ConfigurableProxy ( Configurable *  c = NULL )

inline

Constructor with passed internal Configurable.

Member Function Documentation

addChildConfigurable()

void icl::utils::ConfigurableProxy::addChildConfigurable ( Configurable *  configurable, const std::string &  childPrefix = ""  )

inline

getInternalConfigurable()

Configurable* icl::utils::ConfigurableProxy::getInternalConfigurable ( ) const

inline

returns the internally used Configurable

getPropertyInfo()

std::string icl::utils::ConfigurableProxy::getPropertyInfo ( const std::string &  propertyName ) const

inline

get information of a properties valid values

getPropertyList()

std::vector<std::string> icl::utils::ConfigurableProxy::getPropertyList ( ) const

inline

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

getPropertyToolTip()

std::string icl::utils::ConfigurableProxy::getPropertyToolTip ( const std::string &  propertyName ) const

inline

returns the tooltip description for a given property

getPropertyType()

std::string icl::utils::ConfigurableProxy::getPropertyType ( const std::string &  propertyName ) const

inline

get type of property

getPropertyValue()

Any icl::utils::ConfigurableProxy::getPropertyValue ( const std::string &  propertyName ) const

inline

returns the current value of a property or a parameter

getPropertyVolatileness()

int icl::utils::ConfigurableProxy::getPropertyVolatileness ( const std::string &  propertyName ) const

inline

Returns whether this property may be changed internally.

loadProperties()

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

registerCallback()

void icl::utils::ConfigurableProxy::registerCallback ( Configurable::Callback  cb )

inline

saveProperties()

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

setInternalConfigurable()

void icl::utils::ConfigurableProxy::setInternalConfigurable ( Configurable *  c = NULL )

inline

sets the internally used Configurable to the passed one

setPropertyValue()

void icl::utils::ConfigurableProxy::setPropertyValue ( const std::string &  propertyName, const Any &  value  )

inline

sets a property value

supportsProperty()

bool icl::utils::ConfigurableProxy::supportsProperty ( const std::string &  propertyName ) const

inline

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

syncChangesTo() [1/2]

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

inline

syncronzies all property changes to the given configurable

syncChangesTo() [2/2]

void icl::utils::ConfigurableProxy::syncChangesTo ( ConfigurableProxy *  configurable )

inline

syncronzies all property changes to the given configurable

Member Data Documentation

m_configurableLock

Mutex icl::utils::ConfigurableProxy::m_configurableLock

mutableprivate

m_intConfigurable

Configurable* icl::utils::ConfigurableProxy::m_intConfigurable

private

---

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

• /Users/alneuman/vm/icl/ICLUtils/src/ICLUtils/ConfigurableProxy.h