RTT::base::AttributeBase Class Reference

An attribute is a minimalistic, named placeholder for data. More...

#include <rtt/base/AttributeBase.hpp>

Inheritance diagram for RTT::base::AttributeBase:

Public Member Functions
	AttributeBase ()
	Create a nameless AttributeBase. More...
	AttributeBase (const std::string &name)
	Create an AttributeBase known by a name. More...
virtual	~AttributeBase ()
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...
virtual DataSourceBase::shared_ptr	getDataSource () const =0
	Return a internal::DataSource which contains the same contents. More...
virtual AttributeBase *	clone () const =0
	Returns a clone of this AttributeBase. More...
virtual AttributeBase *	copy (std::map< const DataSourceBase *, DataSourceBase * > &replacements, bool instantiate)=0
	Returns a copy of this AttributeBase. More...

Protected Attributes
std::string	mname

Detailed Description

An attribute is a minimalistic, named placeholder for data.

It is a light-weight equivalent of a Property.

Definition at line 52 of file AttributeBase.hpp.

Constructor & Destructor Documentation

RTT::AttributeBase::AttributeBase

(

)

Create a nameless AttributeBase.

Definition at line 46 of file Attribute.cpp.

RTT::AttributeBase::AttributeBase

(

const std::string &

name

)

Create an AttributeBase known by a name.

Parameters

name

The name.

Definition at line 50 of file Attribute.cpp.

RTT::AttributeBase::~AttributeBase ( )

virtual

Definition at line 55 of file Attribute.cpp.

Member Function Documentation

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

pure virtual

Returns a clone of this AttributeBase.

Implemented in RTT::Alias, RTT::Constant< T >, RTT::Attribute< T >, and RTT::scripting::SendHandleAlias.

Referenced by RTT::ConfigurationInterface::addAttribute(), RTT::ConfigurationInterface::addConstant(), RTT::scripting::FunctionGraph::FunctionGraph(), and RTT::scripting::ProgramGraphParser::parserUsed().

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

pure virtual

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.

Implemented in RTT::Alias, RTT::Constant< T >, RTT::Attribute< T >, and RTT::scripting::SendHandleAlias.

Referenced by RTT::scripting::FunctionGraph::copy().

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

pure virtual

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

Implemented in RTT::Alias, RTT::Constant< T >, RTT::Attribute< T >, and RTT::scripting::SendHandleAlias.

Referenced by RTT::ConfigurationInterface::addAttribute(), RTT::ConfigurationInterface::addConstant(), RTT::types::TypeInfo::construct(), RTT_corba_CConfigurationInterface_i::getAttribute(), RTT_corba_CConfigurationInterface_i::getAttributeDataSource(), RTT::scripting::ExpressionParser::getHandle(), RTT_corba_CConfigurationInterface_i::isAttributeAssignable(), RTT::Attribute< T >::operator=(), RTT::Constant< T >::operator=(), RTT::scripting::ProgramGraphParser::parserUsed(), RTT::scripting::FunctionFactory::produce(), RTT::OperationCallerC::D::ret(), RTT_corba_CConfigurationInterface_i::setAttribute(), RTT::ConfigurationInterface::setValue(), RTT::scripting::ValueChangeParser::ValueChangeParser(), and RTT::OperationCallerC::D::~D().

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

(

)

const

Get the name of this instance.

Returns

the name

Definition at line 59 of file Attribute.cpp.

References 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().

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

inline

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().

void RTT::AttributeBase::setName

(

std::string const &

new_name

)

Get the name of this instance.

Returns

the name

Definition at line 64 of file Attribute.cpp.

References mname.

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

Member Data Documentation

std::string RTT::base::AttributeBase::mname

protected

Definition at line 55 of file AttributeBase.hpp.

Referenced by RTT::scripting::SendHandleAlias::clone(), RTT::Attribute< T >::clone(), RTT::Constant< T >::clone(), RTT::Alias::clone(), RTT::scripting::SendHandleAlias::copy(), RTT::Attribute< T >::copy(), RTT::Constant< T >::copy(), RTT::Alias::copy(), getName(), RTT::Attribute< T >::operator=(), RTT::Constant< T >::operator=(), and setName().

---

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

• rtt/base/AttributeBase.hpp
• rtt/Attribute.cpp