Object that may receive a reference to some data by means of a pointer or data source. More...
#include <rtt/internal/Reference.hpp>
Public Member Functions | |
| virtual void | setReference (void *ref)=0 |
| Sets the reference to a given pointer. | |
| virtual bool | setReference (base::DataSourceBase::shared_ptr dsb)=0 |
| Sets the reference to the data contained in the data source. | |
Detailed Description
Object that may receive a reference to some data by means of a pointer or data source.
Used by ReferenceDataSource in order to allow to modify the reference after creation of the data source.
Definition at line 15 of file Reference.hpp.
Member Function Documentation
| virtual void RTT::internal::Reference::setReference | ( | void * | ref | ) | [pure virtual] |
Sets the reference to a given pointer.
The pointer must have the same type as the data referenced. No type checking is done, so make sure you get this right.
Implemented in RTT::internal::ReferenceDataSource< T >, and RTT::internal::ReferenceDataSource< ds_type >.
| virtual bool RTT::internal::Reference::setReference | ( | base::DataSourceBase::shared_ptr | dsb | ) | [pure virtual] |
Sets the reference to the data contained in the data source.
- Parameters:
-
dsb Must be an assignable data source of the same type of the data. The shared pointer is not necessarily stored, so keep track of the lifetime of dsb, that it lives longer than this object.
- Returns:
- false if setting failed. More precisely this might fail if dynamic_cast'ing the argument to the Reference DataSource fails.
- Note:
- This method will also call evaluate on the dsb to assure the correct value is used.
Implemented in RTT::internal::ReferenceDataSource< T >, and RTT::internal::ReferenceDataSource< ds_type >.
The documentation for this class was generated from the following file:
- rtt/internal/Reference.hpp
