Public Member Functions | Protected Attributes
RTT::base::AttributeBase Class Reference

#include <AttributeBase.hpp>

Inheritance diagram for RTT::base::AttributeBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 AttributeBase ()
 AttributeBase (const std::string &name)
virtual AttributeBaseclone () const =0
virtual AttributeBasecopy (std::map< const DataSourceBase *, DataSourceBase * > &replacements, bool instantiate)=0
virtual DataSourceBase::shared_ptr getDataSource () const =0
const std::string & getName () const
bool ready () const
void setName (std::string const &new_name)
virtual ~AttributeBase ()

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

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:
nameThe name.

Definition at line 50 of file Attribute.cpp.

Definition at line 55 of file Attribute.cpp.


Member Function Documentation

virtual AttributeBase* RTT::base::AttributeBase::clone ( ) const [pure virtual]
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:
instantiateSet to true to get a copy which will return itself on any future copy request.
const std::string & RTT::AttributeBase::getName ( ) const

Get the name of this instance.

Returns:
the name

Definition at line 59 of file Attribute.cpp.

bool RTT::base::AttributeBase::ready ( ) const [inline]

Returns true if the Attribute was correctly initialised.

Definition at line 89 of file AttributeBase.hpp.

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.


Member Data Documentation

std::string RTT::base::AttributeBase::mname [protected]

Definition at line 55 of file AttributeBase.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Mon Oct 6 2014 03:13:58