An Attribute has a name and contains data which can be set and get. More...

#include <rtt/Attribute.hpp>

Inheritance diagram for RTT::Attribute< T >:

Public Member Functions
	Attribute ()
	Create an Attribute with no name and no value. More...

	Attribute (const std::string &name)
	Create an Attribute with a given name and a default value. More...

	Attribute (const std::string &name, T t)
	Create an Attribute with a name and a given value t. More...

template<class Owner >
	Attribute (const std::string &name, T t, Owner o)
	Create an Attribute with a name, a given value t and an owner. More...

	Attribute (const std::string &name, internal::AssignableDataSource< T > *d)
	Create an Attribute which uses a internal::DataSource d. More...

	Attribute (const Attribute< T > &a)
	Copy constructor copies both name and deep copy of the data. More...

Attribute< T > &	operator= (const Attribute< T > &a)
	Assignment copies both name and deep copy of the data. More...

	Attribute (base::AttributeBase *ab)
	Create an Attribute which mirrors a base::AttributeBase ab. More...

Attribute< T > &	operator= (base::AttributeBase *ab)
	Initialise an Attribute which mirrors an base::AttributeBase ab. More...

T const &	get () const
	Get the value of this Attribute. More...

void	set (T const &t)
	Set the value of this Attribute. More...

internal::AssignableDataSource< T >::reference_t	set ()
	Allow to set the value of this Attribute by reference. More...

base::DataSourceBase::shared_ptr	getDataSource () const
	Return a internal::DataSource which contains the same contents. More...

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

Attribute< T > *	clone () const
	Returns a clone of this AttributeBase. More...

Attribute< T > *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &replacements, bool instantiate)
	Returns a copy of this AttributeBase. More...

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

void	setName (std::string const &new_name)
	Get the name of this instance. More...

bool	ready () const
	Returns true if the Attribute was correctly initialised. More...

Protected Attributes
std::string	mname

Detailed Description

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

An Attribute has a name and contains data which can be set and get.

Accessing an attribute (reading/writing) is not thread-safe. It is used to expose a C/C++ variable to the interface of a TaskContext in order to allow plugins or external tools to read and write it.

Parameters

T	The type of data this attribute holds.

Definition at line 56 of file Attribute.hpp.

Constructor & Destructor Documentation

template<typename T>

RTT::Attribute< T >::Attribute ( )

inline

Create an Attribute with no name and no value.

Definition at line 65 of file Attribute.hpp.

template<typename T>

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

inlineexplicit

Create an Attribute with a given name and a default value.

Parameters

name	The name of this instance.

Definition at line 74 of file Attribute.hpp.

template<typename T>

RTT::Attribute< T >::Attribute	(	const std::string &	name,
		T	t
	)

inline

Create an Attribute with a name and a given value t.

Parameters

name	The name of this instance.
t	The value for initialisation.

Definition at line 85 of file Attribute.hpp.

template<typename T>

template<class Owner >

RTT::Attribute< T >::Attribute	(	const std::string &	name,
		T	t,
		Owner	o
	)

inline

Create an Attribute with a name, a given value t and an owner.

The owner is used to register this attribute to and is supposed to be a pointer (or shared pointer).

Parameters

name	The name of this instance.
t	The value for initialisation.
o	The owner, which has a function 'addAttribute(AttributeBase*)'.

Definition at line 101 of file Attribute.hpp.

template<typename T>

RTT::Attribute< T >::Attribute	(	const std::string &	name,
		internal::AssignableDataSource< T > *	d
	)

inline

Create an Attribute which uses a internal::DataSource d.

Parameters

name	The name
d	The data source to read from and write to.

Definition at line 114 of file Attribute.hpp.

template<typename T>

RTT::Attribute< T >::Attribute ( const Attribute< T > & a )

inline

Copy constructor copies both name and deep copy of the data.

Definition at line 123 of file Attribute.hpp.

template<typename T>

RTT::Attribute< T >::Attribute ( base::AttributeBase * ab )

inline

Create an Attribute which mirrors a base::AttributeBase ab.

If successful, this attribute will always have the same value as ab and vice versa.

Parameters

ab	The Attribute to mirror. If null, this will clear this attribute and clear its name.

See also: ready() to check if ab was accepted.

Definition at line 150 of file Attribute.hpp.

Member Function Documentation

template<typename T>

Attribute<T>* RTT::Attribute< T >::clone ( ) const

inlinevirtual

Returns a clone of this AttributeBase.

Implements RTT::base::AttributeBase.

Definition at line 224 of file Attribute.hpp.

References RTT::internal::DataSource< T >::get(), and RTT::base::AttributeBase::mname.

Referenced by RTT::Alias::Alias().

template<typename T>

Attribute<T>* RTT::Attribute< T >::copy	(	std::map< const base::DataSourceBase , base::DataSourceBase > &	replacements,
		bool	instantiate
	)

inlinevirtual

Returns a copy of this AttributeBase.

Uses the given replacements to copy held DataSources.

Parameters

instantiate Set to true to get a copy which will return itself on any future copy request.

Implements RTT::base::AttributeBase.

Definition at line 229 of file Attribute.hpp.

References RTT::internal::AssignableDataSource< T >::clone(), RTT::internal::AssignableDataSource< T >::copy(), RTT::internal::DataSource< T >::get(), and RTT::base::AttributeBase::mname.

Referenced by RTT::Alias::Alias().

template<typename T>

T const& RTT::Attribute< T >::get ( ) const

inline

Get the value of this Attribute.

Definition at line 188 of file Attribute.hpp.

References RTT::internal::DataSource< T >::evaluate(), and RTT::internal::DataSource< T >::rvalue().

template<typename T>

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

inline

Definition at line 219 of file Attribute.hpp.

template<typename T>

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

inlinevirtual

Return a internal::DataSource which contains the same contents.

Implements RTT::base::AttributeBase.

Definition at line 214 of file Attribute.hpp.

Referenced by RTT::Alias::Alias().

const std::string & RTT::AttributeBase::getName ( ) const

inherited

Get the name of this instance.

Returns: the name

Definition at line 59 of file Attribute.cpp.

References RTT::base::AttributeBase::mname.

Referenced by RTT::ConfigurationInterface::getAttributeNames(), RTT::ConfigurationInterface::getValue(), RTT::ConfigurationInterface::hasAttribute(), RTT::Attribute< T >::operator=(), RTT::Constant< T >::operator=(), RTT::ConfigurationInterface::removeValue(), and RTT::ConfigurationInterface::setValue().

template<typename T>

Attribute<T>& RTT::Attribute< T >::operator= ( const Attribute< T > & a )

inline

Assignment copies both name and deep copy of the data.

Definition at line 132 of file Attribute.hpp.

References RTT::base::AttributeBase::mname.

template<typename T>

Attribute<T>& RTT::Attribute< T >::operator= ( base::AttributeBase * ab )

inline

Initialise an Attribute which mirrors an base::AttributeBase ab.

If successful, this attribute will always have the same value as ab and vice versa.

Parameters

ab	The attribute to mirror. If null, this will clear this attribute and clear its name.

See also: ready() to check if ab was accepted.

Definition at line 164 of file Attribute.hpp.

References RTT::base::AttributeBase::getDataSource(), RTT::base::AttributeBase::getName(), and RTT::base::AttributeBase::mname.

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

inlineinherited

Returns true if the Attribute was correctly initialised.

Definition at line 89 of file AttributeBase.hpp.

Referenced by RTT::ConfigurationInterface::addAttribute(), and RTT::ConfigurationInterface::addConstant().

template<typename T>

void RTT::Attribute< T >::set ( T const & t )

inline

Set the value of this Attribute.

In case the attribute is owned by a remote component, the value will be transfered.

Definition at line 199 of file Attribute.hpp.

References RTT::internal::AssignableDataSource< T >::set().

Referenced by RTT::types::RTStringTypeInfo::buildVariable(), and RTT::types::StdStringTypeInfo::buildVariable().

template<typename T>

internal::AssignableDataSource<T>::reference_t RTT::Attribute< T >::set ( )

inline

Allow to set the value of this Attribute by reference.

Don't use this function to set attributes of remote components, since set() will return in that case a copy of the data and the remote side will not be updated.

Definition at line 210 of file Attribute.hpp.

References RTT::internal::AssignableDataSource< T >::set().

void RTT::AttributeBase::setName ( std::string const & new_name )

inherited

Get the name of this instance.