A property represents a named value of any type with a description. More...

#include <Property.hpp>

Inheritance diagram for RTT::Property< T >:

Public Types
typedef boost::call_traits< value_t >::const_reference	const_reference_t

typedef value_t	DataSourceType

typedef boost::call_traits< value_t >::param_type	param_t

typedef boost::call_traits< value_t >::reference	reference_t

typedef boost::remove_const< typename boost::remove_reference< T >::type >::type	value_t

Public Member Functions
virtual Property< T > *	clone () const

template<>
bool	copy (const Property< PropertyBag > &orig)

virtual bool	copy (const base::PropertyBase *other)

bool	copy (const Property< T > &orig)

template<>
RTT_API bool	copy (const Property< PropertyBag > &orig)

virtual Property< T > *	create () const

virtual Property< T > *	create (const base::DataSourceBase::shared_ptr &datasource) const

Property< T > &	doc (const std::string &descr)

DataSourceType	get () const

internal::AssignableDataSource< DataSourceType >::shared_ptr	getAssignableDataSource () const

virtual base::DataSourceBase::shared_ptr	getDataSource () const

virtual std::string	getType () const

virtual const types::TypeInfo *	getTypeInfo () const

template<>
void	identify (PropertyBagVisitor *pbi)

virtual void	identify (base::PropertyIntrospection *pi)

virtual void	identify (base::PropertyBagVisitor *pi)

template<>
RTT_API void	identify (base::PropertyBagVisitor *pbi)

	operator value_t () const

Property< T > &	operator<<= (Property< T > &p)

Property< T > &	operator= (param_t value)

Property< T > &	operator= (base::PropertyBase *source)

	Property ()

	Property (const std::string &name)

	Property (const std::string &name, const std::string &description, param_t value=value_t())

	Property (const Property< T > &orig)

	Property (base::PropertyBase *source)

	Property (const std::string &name, const std::string &description, const typename internal::AssignableDataSource< DataSourceType >::shared_ptr &datasource)

template<>
bool	refresh (const Property< PropertyBag > &orig)

virtual bool	refresh (const base::PropertyBase *other)

bool	refresh (const Property< T > &orig)

template<>
RTT_API bool	refresh (const Property< PropertyBag > &orig)

const_reference_t	rvalue () const

reference_t	set ()

void	set (param_t v)

virtual bool	setDataSource (const base::DataSourceBase::shared_ptr &dsb)

template<>
bool	update (const Property< PropertyBag > &orig)

virtual bool	update (const base::PropertyBase *other)

bool	update (const Property< T > &orig)

template<>
RTT_API bool	update (const Property< PropertyBag > &orig)

reference_t	value ()

Public Member Functions inherited from RTT::base::PropertyBase
virtual bool	compose (const PropertyBag &source)

const std::string &	getDescription () const

const std::string &	getName () const

	PropertyBase (std::string name, std::string description)

	PropertyBase ()

bool	ready () const

void	setDescription (const std::string &desc)

void	setName (const std::string &name)

virtual	~PropertyBase ()

Static Public Member Functions
static Property< T > *	narrow (base::PropertyBase *prop)

Protected Attributes
internal::AssignableDataSource< DataSourceType >::shared_ptr	_value

Protected Attributes inherited from RTT::base::PropertyBase
std::string	_description

std::string	_name

Detailed Description

template<typename T>
class RTT::Property< T >

A property represents a named value of any type with a description.

A property is a tuple of a name, a description and a variable of any type. It's purpose is to provide a hierarchical parameter of a component. They are grouped in PropertyBag objects and a Property can contain a PropertyBag itself.

If you do not provide a name nor description when constructing the Property object, it will be uninitialised and ready() will return false. Such an object may not be used (set(), get(),...) until it has been initialised from another Property. Otherwise, an exception (or assert) will be thrown.

Parameters

T	The type of the data contained within the Property.

Definition at line 76 of file Property.hpp.

Member Typedef Documentation

template<typename T>

typedef boost::call_traits<value_t>::const_reference RTT::Property< T >::const_reference_t

Definition at line 88 of file Property.hpp.

template<typename T>

typedef value_t RTT::Property< T >::DataSourceType

Definition at line 89 of file Property.hpp.

template<typename T>

typedef boost::call_traits<value_t>::param_type RTT::Property< T >::param_t

Definition at line 86 of file Property.hpp.

template<typename T>

typedef boost::call_traits<value_t>::reference RTT::Property< T >::reference_t

Definition at line 87 of file Property.hpp.

template<typename T>

typedef boost::remove_const<typename boost::remove_reference<T>::type>::type RTT::Property< T >::value_t

The types of this property type. value_t is always the 'bare' value type of T. From this type, we derive the other (param, ref, ...) types.

Definition at line 85 of file Property.hpp.

Constructor & Destructor Documentation

template<typename T>

RTT::Property< T >::Property ( )

inline

Create an empty Property with no name, no description and no value.

Postcondition: ready() will return false. Initialise this Property with another Property object.

Definition at line 95 of file Property.hpp.

template<typename T>

RTT::Property< T >::Property ( const std::string & name )

inlineexplicit

The constructor which initializes the property's value to the default.

Parameters

name	The name which will be used to refer to the property.

Postcondition: ready() will always be true.

Definition at line 104 of file Property.hpp.

template<typename T>

RTT::Property< T >::Property	(	const std::string &	name,
		const std::string &	description,
		param_t	value = `value_t()`
	)

inline

The constructor which initializes the property's value.

Parameters

name	The name which will be used to refer to the property.
description	The description of the property.
value	The initial value of the property (optional).

Postcondition: ready() will always be true.

Definition at line 117 of file Property.hpp.

template<typename T>

RTT::Property< T >::Property ( const Property< T > & orig )

inline

Copy constructors copies the name, description and value as deep copies.

Postcondition: ready() will be true if orig.ready() is true.

Definition at line 127 of file Property.hpp.

template<typename T>

RTT::Property< T >::Property ( base::PropertyBase * source )

inline

Create a Property mirroring another PropertyBase. It copies the name and description, and shallow copies the value.

See also: ready() to inspect if the creation succeeded.

Definition at line 142 of file Property.hpp.

template<typename T>

RTT::Property< T >::Property	(	const std::string &	name,
		const std::string &	description,
		const typename internal::AssignableDataSource< DataSourceType >::shared_ptr &	datasource
	)

inline

The constructor which initializes the property with a DataSource.

Parameters

name	The name which will be used to refer to the property.
description	The description of the property.
datasource	A new data source to be acquired by this property for storing its data.

Postcondition: ready() will be true if datasource is a valid pointer.

Definition at line 167 of file Property.hpp.

Member Function Documentation

template<typename T>

virtual Property<T>* RTT::Property< T >::clone ( ) const

inlinevirtual

Deliver an identical clone of this PropertyBase. The original may be deleted and the clone can be transparantly used in its place or vice versa.

Implements RTT::base::PropertyBase.

Definition at line 371 of file Property.hpp.

template<>

bool RTT::Property< PropertyBag >::copy ( const Property< PropertyBag > & orig )

Definition at line 284 of file PropertyBag.cpp.

template<typename T>

virtual bool RTT::Property< T >::copy ( const base::PropertyBase * other )

inlinevirtual

Copy an other Property onto this property. Copy does a full update of the name, description and value, adding extra information if necessary, or in case of a Property<PropertyBag> adding all Properties.

Copy only works on properties that are ready() and both have the same data type T.

Returns: false if the Properties are of different type.

Implements RTT::base::PropertyBase.

Definition at line 323 of file Property.hpp.

template<typename T>

bool RTT::Property< T >::copy ( const Property< T > & orig )

inline

Copy the value, complete overwrite of this Property with orig.

Definition at line 335 of file Property.hpp.

template<>

RTT_API bool RTT::Property< PropertyBag >::copy ( const Property< PropertyBag > & orig )

template<typename T>

virtual Property<T>* RTT::Property< T >::create ( ) const

inlinevirtual

Create a new default instance of the PropertyBase. This is a factory method to 'make something of the same type'. The new PropertyBase has the same name and description as this.

Implements RTT::base::PropertyBase.

Definition at line 376 of file Property.hpp.

template<typename T>

virtual Property<T>* RTT::Property< T >::create ( const base::DataSourceBase::shared_ptr & datasource ) const

inlinevirtual

Create a new instance of the PropertyBase with a custom data source. This is a factory method to 'make something of the same type'. The new PropertyBase has the same name and description as this.

Implements RTT::base::PropertyBase.

Definition at line 381 of file Property.hpp.

template<typename T>

Property<T>& RTT::Property< T >::doc ( const std::string & descr )

inline

Documents this property.

Parameters

descr The description of this property

Returns: A reference to this object.

Definition at line 228 of file Property.hpp.

template<typename T>

DataSourceType RTT::Property< T >::get ( ) const

inline

Get a copy of the value of the property.

Returns: The value of the property.

Definition at line 246 of file Property.hpp.

template<typename T>

internal::AssignableDataSource<DataSourceType>::shared_ptr RTT::Property< T >::getAssignableDataSource ( ) const

inline

Definition at line 397 of file Property.hpp.

template<typename T>

virtual base::DataSourceBase::shared_ptr RTT::Property< T >::getDataSource ( ) const

inlinevirtual

Get an assignable base::DataSource through which this PropertyBase can be manipulated.

Implements RTT::base::PropertyBase.

Definition at line 393 of file Property.hpp.

template<typename T>

virtual std::string RTT::Property< T >::getType ( ) const

inlinevirtual

Returns the type of this PropertyBase. Uses the naming scheme of DataSourceTypeInfo.

Implements RTT::base::PropertyBase.

Definition at line 417 of file Property.hpp.

template<typename T>

virtual const types::TypeInfo* RTT::Property< T >::getTypeInfo ( ) const

inlinevirtual

Returns the types::TypeInfo object of this Property.

Implements RTT::base::PropertyBase.

Definition at line 421 of file Property.hpp.

template<>

void RTT::Property< PropertyBag >::identify ( PropertyBagVisitor * pi )

virtual

A call on this method will lead to a call to the PropertyBagIntrospection interface identifying this Property's proper type.

Deprecated:: DO NOT USE. Will be removed in 2.x release series.

Reimplemented from RTT::base::PropertyBase.

Definition at line 53 of file Property.cpp.

template<class T >

void RTT::Property< T >::identify ( base::PropertyIntrospection * pi )

virtual

A call on this method will lead to a call to the PropertyIntrospection interface identifying this Property's proper type.

Deprecated:: DO NOT USE. Will be removed in 2.x release series.

Implements RTT::base::PropertyBase.

Definition at line 462 of file Property.hpp.

template<class T >

void RTT::Property< T >::identify ( base::PropertyBagVisitor * pi )

virtual

A call on this method will lead to a call to the PropertyBagIntrospection interface identifying this Property's proper type.

Deprecated:: DO NOT USE. Will be removed in 2.x release series.

Reimplemented from RTT::base::PropertyBase.

Definition at line 468 of file Property.hpp.

template<>

RTT_API void RTT::Property< PropertyBag >::identify ( base::PropertyBagVisitor * pi )

virtual

A call on this method will lead to a call to the PropertyBagIntrospection interface identifying this Property's proper type.

Deprecated:: DO NOT USE. Will be removed in 2.x release series.

Reimplemented from RTT::base::PropertyBase.

template<class T >

Property< T > * RTT::Property< T >::narrow ( base::PropertyBase * prop )

static

Use this method instead of dynamic_cast<> to cast from base::PropertyBase to Property<T>. You need to delete the returned property if it is no longer needed.

Parameters

T	The Desired property type, for example 'double'.
prop	The property to narrow to Property<T>.

Returns: Null if prop is not convertible to type Property<T>, a new Property<T> instance otherwise.

Definition at line 451 of file Property.hpp.

template<typename T>

RTT::Property< T >::operator value_t ( ) const

inline

Get a copy of the value of the property.

Returns: A copy of the value of the property.

Definition at line 237 of file Property.hpp.

template<typename T>

Property<T>& RTT::Property< T >::operator<<= ( Property< T > & p )

inline

Update the value of this property with another property.

Definition at line 217 of file Property.hpp.

template<typename T>

Property<T>& RTT::Property< T >::operator= ( param_t value )

inline

Set the property's value.

Parameters

value The value to be set.

Returns: A reference to newly set property value.

Definition at line 181 of file Property.hpp.

template<typename T>

Property<T>& RTT::Property< T >::operator= ( base::PropertyBase * source )

inlinevirtual

Mirror another PropertyBase (name, description and value).

Parameters

source A pointer to the property to mirror.

Implements RTT::base::PropertyBase.

Definition at line 191 of file Property.hpp.

template<>

bool RTT::Property< PropertyBag >::refresh ( const Property< PropertyBag > & orig )

Definition at line 276 of file PropertyBag.cpp.

template<typename T>

virtual bool RTT::Property< T >::refresh ( const base::PropertyBase * other )

inlinevirtual

Refresh the value of this Property with the value of an other Property. Refresh does only the minimal update of the value, not adding extra information, or in case of a Property<PropertyBag> not adding extra Properties.

Refresh only works on properties that are ready() and both have the same data type T.

Returns: false if the Properties are of different type.

Implements RTT::base::PropertyBase.

Definition at line 314 of file Property.hpp.

template<typename T>

bool RTT::Property< T >::refresh ( const Property< T > & orig )

inline

Refresh only the value from a Property. This is a real-time operation.

Definition at line 363 of file Property.hpp.

template<>

RTT_API bool RTT::Property< PropertyBag >::refresh ( const Property< PropertyBag > & orig )

template<typename T>

const_reference_t RTT::Property< T >::rvalue ( ) const

inline

Read-only (const&) access to the value of the Property.

Definition at line 285 of file Property.hpp.

template<typename T>

reference_t RTT::Property< T >::set ( )

inline

Access to the value of the Property. Identical to value().

Warning: This function is not suitable for remote (distributed) access of properties, use operator=() or set( param_t v ) to assign a value.

Definition at line 257 of file Property.hpp.

template<typename T>

void RTT::Property< T >::set ( param_t v )

inline

Set the value of the Property.

Definition at line 265 of file Property.hpp.

template<typename T>

virtual bool RTT::Property< T >::setDataSource ( const base::DataSourceBase::shared_ptr & dsb )

inlinevirtual

Assign an external assignable base::DataSource to this property.

Parameters

dsb	The other data source

Returns: false if the properties are of different type.

Implements RTT::base::PropertyBase.

Definition at line 406 of file Property.hpp.

template<>

bool RTT::Property< PropertyBag >::update ( const Property< PropertyBag > & orig )

Definition at line 266 of file PropertyBag.cpp.

template<typename T>

virtual bool RTT::Property< T >::update ( const base::PropertyBase * other )

inlinevirtual

Update the value of this Property with the value of an other Property. Update does a full update of the value, adding extra information if necessary, or in case of a Property<PropertyBag> adding missing Properties.

Update only works on properties that are ready() and both have the same data type T.

Returns: false if the Properties are of different type or if this->ready() == false.

Implements RTT::base::PropertyBase.

Definition at line 305 of file Property.hpp.

template<typename T>

bool RTT::Property< T >::update ( const Property< T > & orig )

inline

Update the value, optionally also the description if current description is empty.

Definition at line 349 of file Property.hpp.

template<>

RTT_API bool RTT::Property< PropertyBag >::update ( const Property< PropertyBag > & orig )

Partial specialisations in case of PropertyBag.

template<typename T>

reference_t RTT::Property< T >::value ( )

inline

Access to the value of the Property. Identical to set().

Warning: This function is not suitable for remote (distributed) access of properties, use operator=() or set( param_t v ) to assign a value.

Definition at line 277 of file Property.hpp.

Member Data Documentation

template<typename T>

internal::AssignableDataSource<DataSourceType>::shared_ptr RTT::Property< T >::_value

protected

Definition at line 425 of file Property.hpp.

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

Property.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class RTT::Property< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class RTT::Property< T >