RTT::base::AttributeBase Class Reference

#include <AttributeBase.hpp>

Inheritance diagram for RTT::base::AttributeBase:

[legend]

List of all members.

Public Member Functions
	AttributeBase (const std::string &name)
	AttributeBase ()
	AttributeBase (const std::string &name)
	AttributeBase ()
virtual AttributeBase *	clone () const =0
virtual AttributeBase *	clone () const =0
virtual AttributeBase *	copy (std::map< const DataSourceBase *, DataSourceBase * > &replacements, bool instantiate)=0
virtual AttributeBase *	copy (std::map< const DataSourceBase *, DataSourceBase * > &replacements, bool instantiate)=0
virtual DataSourceBase::shared_ptr	getDataSource () const =0
virtual DataSourceBase::shared_ptr	getDataSource () const =0
const std::string &	getName () const
const std::string &	getName () const
bool	ready () const
bool	ready () const
void	setName (std::string const &new_name)
void	setName (std::string const &new_name)
virtual	~AttributeBase ()
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 50 of file install/include/rtt/base/AttributeBase.hpp.

---

Constructor & Destructor Documentation

RTT::AttributeBase::AttributeBase

(

)

Create a nameless AttributeBase.

Definition at line 43 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 47 of file Attribute.cpp.

RTT::AttributeBase::~AttributeBase

(

)

[virtual]

Definition at line 52 of file Attribute.cpp.

RTT::base::AttributeBase::AttributeBase

(

)

Create a nameless AttributeBase.

RTT::base::AttributeBase::AttributeBase

(

const std::string &

name

)

Create an AttributeBase known by a name.

Parameters:

name

The name.

virtual RTT::base::AttributeBase::~AttributeBase

(

)

[virtual]

---

Member Function Documentation

virtual AttributeBase* RTT::base::AttributeBase::clone

(

)

const [pure virtual]

Returns a clone of this AttributeBase.

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

virtual AttributeBase* RTT::base::AttributeBase::clone

(

)

const [pure virtual]

Returns a clone of this AttributeBase.

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

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.

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.

virtual DataSourceBase::shared_ptr RTT::base::AttributeBase::getDataSource

(

)

const [pure virtual]

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

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

virtual DataSourceBase::shared_ptr RTT::base::AttributeBase::getDataSource

(

)

const [pure virtual]

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

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

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

(

)

const

Get the name of this instance.

Returns:

the name

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

(

)

const

Get the name of this instance.

Returns:

the name

Definition at line 56 of file Attribute.cpp.

bool RTT::base::AttributeBase::ready

(

void

)

const [inline]

Returns true if the Attribute was correctly initialised.

Definition at line 79 of file rtt/base/AttributeBase.hpp.

bool RTT::base::AttributeBase::ready

(

)

const [inline]

Returns true if the Attribute was correctly initialised.

Definition at line 79 of file install/include/rtt/base/AttributeBase.hpp.

void RTT::base::AttributeBase::setName

(

std::string const &

new_name

)

Get the name of this instance.

Returns:

the name

void RTT::AttributeBase::setName

(

std::string const &

new_name

)

Get the name of this instance.

Returns:

the name

Definition at line 61 of file Attribute.cpp.

---

Member Data Documentation

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

Definition at line 45 of file install/include/rtt/base/AttributeBase.hpp.

---

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

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