Orocos Real-Time Toolkit
2.8.3
|
A DataObjectInterface implements multi-threaded read/write solutions. More...
#include <rtt/base/DataObjectInterface.hpp>
Public Types | |
typedef boost::shared_ptr< DataObjectInterface< T > > | shared_ptr |
Used for shared_ptr management. More... | |
typedef T | DataType |
The type of the data. More... | |
Public Member Functions | |
DataObjectInterface () | |
Create a DataObject which is initially not reference counted. More... | |
virtual | ~DataObjectInterface () |
Destructor. More... | |
virtual void | Get (DataType &pull) const =0 |
Get a copy of the Data of this data object. More... | |
virtual DataType | Get () const =0 |
Get a copy of the data of this data object. More... | |
virtual void | Set (const DataType &push)=0 |
Set the data to a certain value. More... | |
virtual void | data_sample (const DataType &sample)=0 |
Provides a data sample to initialize this data object. More... | |
A DataObjectInterface implements multi-threaded read/write solutions.
T | The DataType which can be Get() or Set() with this DataObject. |
Definition at line 56 of file DataObjectInterface.hpp.
typedef T RTT::base::DataObjectInterface< T >::DataType |
The type of the data.
Definition at line 78 of file DataObjectInterface.hpp.
typedef boost::shared_ptr<DataObjectInterface<T> > RTT::base::DataObjectInterface< T >::shared_ptr |
Used for shared_ptr management.
Definition at line 62 of file DataObjectInterface.hpp.
|
inline |
Create a DataObject which is initially not reference counted.
Definition at line 67 of file DataObjectInterface.hpp.
|
inlinevirtual |
Destructor.
Definition at line 73 of file DataObjectInterface.hpp.
|
pure virtual |
Provides a data sample to initialize this data object.
As such enough storage space can be allocated before the actual writing begins.
sample |
Implemented in RTT::base::DataObjectLockFree< T >, RTT::base::DataObjectLocked< T >, and RTT::base::DataObjectUnSync< T >.
Referenced by RTT::internal::ChannelDataElement< T >::data_sample().
|
pure virtual |
Get a copy of the Data of this data object.
pull | A copy of the data. |
Implemented in RTT::base::DataObjectLockFree< T >, RTT::base::DataObjectLocked< T >, and RTT::base::DataObjectUnSync< T >.
Referenced by RTT::internal::ChannelDataElement< T >::data_sample(), RTT::internal::DataObjectDataSource< T >::evaluate(), RTT::internal::DataObjectDataSource< T >::get(), RTT::OutputPort< T >::getLastWrittenValue(), and RTT::internal::ChannelDataElement< T >::read().
|
pure virtual |
Get a copy of the data of this data object.
Implemented in RTT::base::DataObjectLockFree< T >, RTT::base::DataObjectLocked< T >, and RTT::base::DataObjectUnSync< T >.
|
pure virtual |
Set the data to a certain value.
push | The data which must be set. |
Implemented in RTT::base::DataObjectLockFree< T >, RTT::base::DataObjectLocked< T >, and RTT::base::DataObjectUnSync< T >.
Referenced by RTT::internal::ChannelDataElement< T >::write().