Base class for all properties. More...

#include <rtt/base/PropertyBase.hpp>

Inheritance diagram for RTT::base::PropertyBase:

Public Member Functions
virtual	~PropertyBase ()
	The default destructor. More...

	PropertyBase (std::string name, std::string description)
	The constructor. More...

	PropertyBase ()
	Create an uninitialised PropertyBase. More...

virtual PropertyBase &	operator= (PropertyBase *source)=0
	Mirror another PropertyBase (name, description and value). More...

const std::string &	getName () const
	Get the name of the property. More...

void	setName (const std::string &name)
	Set the name of the property. More...

const std::string &	getDescription () const
	Get a description of the property. More...

void	setDescription (const std::string &desc)
	Set the description of the property. More...

bool	ready () const
	Inspect if this Property is correctly initialised and ready for usage. More...

virtual void	identify (PropertyIntrospection *pi)=0
	A call on this method will lead to a call to the PropertyIntrospection interface identifying this Property's proper type. More...

virtual void	identify (PropertyBagVisitor *pi)
	A call on this method will lead to a call to the PropertyBagIntrospection interface identifying this Property's proper type. More...

virtual bool	update (const PropertyBase *other)=0
	Update the value of this Property with the value of an other Property. More...

virtual bool	refresh (const PropertyBase *other)=0
	Refresh the value of this Property with the value of an other Property. More...

virtual bool	copy (const PropertyBase *other)=0
	Copy an other Property onto this property. More...

virtual bool	compose (const PropertyBag &source)
	Composes the data of this property with information found in a PropertyBag. More...

virtual PropertyBase *	clone () const =0
	Deliver an identical clone of this PropertyBase. More...

virtual PropertyBase *	create () const =0
	Create a new default instance of the PropertyBase. More...

virtual PropertyBase *	create (const base::DataSourceBase::shared_ptr &datasource) const =0
	Create a new instance of the PropertyBase with a custom data source. More...

virtual DataSourceBase::shared_ptr	getDataSource () const =0
	Get an assignable base::DataSource through which this PropertyBase can be manipulated. More...

virtual bool	setDataSource (const DataSourceBase::shared_ptr &dsb)=0
	Assign an external assignable base::DataSource to this property. More...

virtual std::string	getType () const =0
	Returns the type of this PropertyBase. More...

virtual const types::TypeInfo *	getTypeInfo () const =0
	Returns the types::TypeInfo object of this Property. More...

Protected Attributes
std::string	_name
	A short name for this PropertyBase. More...

std::string	_description
	A lengthy description for this PropertyBase. More...

Detailed Description

Base class for all properties.

Definition at line 56 of file PropertyBase.hpp.

Constructor & Destructor Documentation

RTT::PropertyBase::~PropertyBase ( )

virtual

The default destructor.

Definition at line 49 of file PropertyBase.cpp.

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

The constructor.

Parameters

name	The name which will be used to refer to this property.
description	A more elaborate description of the property.

Definition at line 55 of file PropertyBase.cpp.

RTT::PropertyBase::PropertyBase ( )

Create an uninitialised PropertyBase.

Definition at line 52 of file PropertyBase.cpp.

Member Function Documentation

virtual PropertyBase* RTT::base::PropertyBase::clone ( ) const

pure virtual

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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::marsh::PropertyBagIntrospector::introspect().

bool RTT::PropertyBase::compose ( const PropertyBag & source )

virtual

Composes the data of this property with information found in a PropertyBag.

This only works for data types that defined a compose/decompose function in their type info structure.

Definition at line 80 of file PropertyBase.cpp.

References getDataSource(), and RTT::base::DataSourceBase::ref().

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

pure virtual

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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::copyProperties().

virtual PropertyBase* RTT::base::PropertyBase::create ( ) const

pure virtual

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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::copyProperties(), RTT::PropertyBag::operator=(), RTT::updateProperties(), and RTT::updateProperty().

virtual PropertyBase* RTT::base::PropertyBase::create ( const base::DataSourceBase::shared_ptr & datasource ) const

pure virtual

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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

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

pure virtual

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

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by compose(), RTT::extras::composeProperty(), RTT::types::composePropertyBag(), RTT::base::PropertyBagVisitor::introspectAndDecompose(), RTT::base::operator<<(), RTT::Property< bool >::operator=(), RTT::Property< bool >::Property(), RTT::types::propertyDecomposition(), RTT::types::typeDecomposition(), RTT::updateOrRefreshProperty(), RTT::updateProperties(), and RTT::scripting::ValueParser::ValueParser().

const std::string& RTT::base::PropertyBase::getDescription ( ) const

inline

Get a description of the property.

Returns: description of the property.

Definition at line 100 of file PropertyBase.hpp.

Referenced by RTT::types::composePropertyBag(), RTT::Property< T >::copy(), RTT::Property< bool >::copy(), RTT::types::decomposePropertyBag(), RTT::marsh::PropertyBagIntrospector::introspect(), RTT::base::PropertyBagVisitor::introspectAndDecompose(), RTT::Property< bool >::operator=(), RTT::Property< T >::update(), RTT::Property< bool >::update(), and RTT::updateProperties().

const std::string& RTT::base::PropertyBase::getName ( ) const

inline

Get the name of the property.

Returns: name of the property.

Definition at line 88 of file PropertyBase.hpp.

Referenced by RTT::ConfigurationInterface::addProperty(), RTT::types::composePropertyBag(), RTT::types::composeTemplateProperty(), RTT::Property< T >::copy(), RTT::Property< bool >::copy(), RTT::types::decomposePropertyBag(), RTT::findProperty(), RTT::flattenPropertyBag(), RTT::PropertyBag::identify(), RTT::marsh::PropertyBagIntrospector::introspect(), RTT::base::PropertyBagVisitor::introspectAndDecompose(), RTT::PropertyBag::FindPropType< T >::operator()(), RTT::operator<<(), RTT::Property< bool >::operator=(), RTT::Property< bool >::Property(), RTT::refreshProperties(), RTT::refreshProperty(), RTT::ConfigurationInterface::removeProperty(), RTT::marsh::XMLRPCMarshaller< output_stream >::serialize(), RTT::scripting::ConditionBoolProperty::toString(), RTT::updateOrRefreshProperty(), RTT::updateProperties(), RTT::updateProperty(), and RTT::scripting::ValueParser::ValueParser().

virtual std::string RTT::base::PropertyBase::getType ( ) const

pure virtual

Returns the type of this PropertyBase.

Uses the naming scheme of DataSourceTypeInfo.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::extras::composeProperty(), RTT::types::composePropertyBag(), RTT::types::composeTemplateProperty(), RTT::types::decomposePropertyBag(), RTT::refreshProperties(), and RTT::updateOrRefreshProperty().

virtual const types::TypeInfo* RTT::base::PropertyBase::getTypeInfo ( ) const

pure virtual

Returns the types::TypeInfo object of this Property.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::types::decomposePropertyBag(), RTT::base::PropertyBagVisitor::introspectAndDecompose(), RTT::types::typeDecomposition(), RTT::updateOrRefreshProperty(), and RTT::updateProperties().

virtual void RTT::base::PropertyBase::identify ( PropertyIntrospection * pi )

pure 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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::Property< T >::identify().

void RTT::PropertyBase::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 in RTT::Property< T >, RTT::Property< T >, RTT::Property< bool >, and RTT::Property< T >.

Definition at line 47 of file Property.cpp.

References RTT::base::PropertyBagVisitor::introspect().

virtual PropertyBase& RTT::base::PropertyBase::operator= ( PropertyBase * source )

pure virtual

Mirror another PropertyBase (name, description and value).

Parameters

source A pointer to the property to mirror.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

bool RTT::base::PropertyBase::ready ( ) const

inline

Inspect if this Property is correctly initialised and ready for usage.

A Property may only be used when ready() returns true, otherwise, an exception is thrown.

Definition at line 114 of file PropertyBase.hpp.

Referenced by RTT::PropertyBag::addProperty(), RTT::ConfigurationInterface::addProperty(), RTT::types::composePropertyBag(), RTT::Property< bool >::copy(), RTT::types::decomposePropertyBag(), RTT::findProperty(), RTT::PropertyBag::findValue(), RTT::PropertyBag::ownProperty(), RTT::Property< bool >::refresh(), RTT::removeProperty(), and RTT::Property< bool >::update().

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

pure virtual

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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::refreshProperty(), and RTT::updateOrRefreshProperty().

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

pure virtual

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

Parameters

dsb	The other data source

Returns: false if the Properties are of different type.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

void RTT::PropertyBase::setDescription ( const std::string & desc )

Set the description of the property.

Parameters

desc	The description of the property.

Definition at line 64 of file PropertyBase.cpp.

References _description.

Referenced by RTT::Property< bool >::doc(), and RTT::Property< bool >::operator=().

void RTT::PropertyBase::setName ( const std::string & name )

Set the name of the property.

Parameters

name	The name of the property.

Definition at line 59 of file PropertyBase.cpp.

References _name.

Referenced by RTT::ConfigurationInterface::addProperty(), and RTT::Property< bool >::operator=().

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

pure virtual

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.

Implemented in RTT::Property< T >, and RTT::Property< bool >.

Referenced by RTT::updateOrRefreshProperty(), and RTT::updateProperties().

Member Data Documentation

std::string RTT::base::PropertyBase::_description

protected

A lengthy description for this PropertyBase.

Definition at line 228 of file PropertyBase.hpp.

Referenced by RTT::Property< bool >::copy(), RTT::Property< bool >::create(), setDescription(), and RTT::Property< bool >::update().

std::string RTT::base::PropertyBase::_name

protected

A short name for this PropertyBase.

Definition at line 223 of file PropertyBase.hpp.

Referenced by RTT::Property< bool >::copy(), RTT::Property< bool >::create(), and setName().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation