RTT::AttributeBase Class Reference
An attribute is a minimalistic, named placeholder for data. More...
#include <rtt/AttributeBase.hpp>
Inheritance diagram for RTT::AttributeBase:
Public Member Functions | |
| AttributeBase () | |
| Create a nameless AttributeBase. | |
| AttributeBase (const std::string &name) | |
| Create an AttributeBase known by a name. | |
| const std::string & | getName () const |
| Get the name of this instance. | |
| bool | ready () const |
| Returns true if the Attribute was correctly initialised. | |
| virtual DataSourceBase::shared_ptr | getDataSource () const =0 |
| Return a DataSource which contains the same contents. | |
| virtual AttributeBase * | clone () const =0 |
| Returns a clone of this AttributeBase. | |
| virtual AttributeBase * | copy (std::map< const DataSourceBase *, DataSourceBase * > &replacements, bool instantiate)=0 |
| Returns a copy of this 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 51 of file AttributeBase.hpp.
Constructor & Destructor Documentation
| RTT::AttributeBase::AttributeBase | ( | const std::string & | name | ) |
Create an AttributeBase known by a name.
- Parameters:
-
name The name.
Member Function Documentation
| virtual AttributeBase* RTT::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::Attribute< T >, RTT::Constant< T >, and RTT::Alias< T >.
| const std::string& RTT::AttributeBase::getName | ( | ) | const |
Get the name of this instance.
- Returns:
- the name
The documentation for this class was generated from the following file:
