Orocos Real-Time Toolkit  2.9.0
DataObjectInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Mon Jan 19 14:11:26 CET 2004 DataObjectInterface.hpp
3 
4  DataObjectInterface.hpp - description
5  -------------------
6  begin : Mon January 19 2004
7  copyright : (C) 2004 Peter Soetens
8  email : peter.soetens@mech.kuleuven.ac.be
9 
10  ***************************************************************************
11  * This library is free software; you can redistribute it and/or *
12  * modify it under the terms of the GNU General Public *
13  * License as published by the Free Software Foundation; *
14  * version 2 of the License. *
15  * *
16  * As a special exception, you may use this file as part of a free *
17  * software library without restriction. Specifically, if other files *
18  * instantiate templates or use macros or inline functions from this *
19  * file, or you compile this file and link it with other files to *
20  * produce an executable, this file does not by itself cause the *
21  * resulting executable to be covered by the GNU General Public *
22  * License. This exception does not however invalidate any other *
23  * reasons why the executable file might be covered by the GNU General *
24  * Public License. *
25  * *
26  * This library is distributed in the hope that it will be useful, *
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
29  * Lesser General Public License for more details. *
30  * *
31  * You should have received a copy of the GNU General Public *
32  * License along with this library; if not, write to the Free Software *
33  * Foundation, Inc., 59 Temple Place, *
34  * Suite 330, Boston, MA 02111-1307 USA *
35  * *
36  ***************************************************************************/
37 
38 #ifndef CORELIB_DATAOBJECTINTERFACE_HPP
39 #define CORELIB_DATAOBJECTINTERFACE_HPP
40 
41 #include "DataObjectBase.hpp"
42 #include "../FlowStatus.hpp"
43 #include <boost/call_traits.hpp>
44 #include <boost/shared_ptr.hpp>
45 
46 namespace RTT
47 { namespace base {
48 
49 
57  template <class T>
59  {
60  public:
61  typedef T value_t;
62  typedef typename boost::call_traits<T>::param_type param_t;
63  typedef typename boost::call_traits<T>::reference reference_t;
64 
68  typedef typename boost::shared_ptr<DataObjectInterface<T> > shared_ptr;
69 
74 
78  virtual ~DataObjectInterface() {}
79 
87  virtual FlowStatus Get( reference_t pull, bool copy_old_data = true ) const = 0;
88 
94  virtual value_t Get() const = 0;
95 
101  virtual bool Set( param_t push ) = 0;
102 
112  virtual bool data_sample( param_t sample, bool reset = true ) = 0;
113 
117  virtual value_t data_sample() const = 0;
118 
123  virtual void clear() = 0;
124  };
125 }}
126 
127 #endif
128 
boost::shared_ptr< DataObjectInterface< T > > shared_ptr
Used for shared_ptr management.
virtual ~DataObjectInterface()
Destructor.
FlowStatus
Returns the status of a data flow read operation.
Definition: FlowStatus.hpp:56
virtual value_t data_sample() const =0
Reads back a data sample.
boost::call_traits< T >::param_type param_t
A DataObjectInterface implements multi-threaded read/write solutions.
DataObjectInterface()
Create a DataObject which is initially not reference counted.
boost::call_traits< T >::reference reference_t
virtual bool Set(param_t push)=0
Set the data to a certain value.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
virtual value_t Get() const =0
Get a copy of the data of this data object.
Base class for all data object classes.
virtual void clear()=0
Clears any data stored by this data object, so that any subsequent Get() without a new Set() will ret...