Orocos Real-Time Toolkit  2.9.0
DataObjectUnSync.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:07 CEST 2009 DataObjectUnSync.hpp
3 
4  DataObjectUnSync.hpp - description
5  -------------------
6  begin : Thu October 22 2009
7  copyright : (C) 2009 Peter Soetens
8  email : peter@thesourcworks.com
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 
39 
40 #ifndef CORELIB_DATAOBJECT_UNSYNC_HPP
41 #define CORELIB_DATAOBJECT_UNSYNC_HPP
42 
43 
44 #include "DataObjectInterface.hpp"
45 
46 namespace RTT
47 { namespace base {
48 
54  template<class T>
56  : public DataObjectInterface<T>
57  {
58  typedef typename DataObjectInterface<T>::value_t value_t;
61 
65  value_t data;
66 
67  mutable FlowStatus status;
68  bool initialized;
69 
70  public:
75  : data(), status(NoData), initialized(false) {}
76 
80  DataObjectUnSync( param_t initial_value )
81  : data(initial_value), status(NoData), initialized(true) {}
82 
83  virtual FlowStatus Get( reference_t pull, bool copy_old_data = true ) const {
84  FlowStatus result = status;
85  if (status == NewData) {
86  pull = data;
87  status = OldData;
88  } else if ((status == OldData) && copy_old_data) {
89  pull = data;
90  }
91  return result;
92  }
93 
94  virtual value_t Get() const {
95  value_t cache = value_t();
96  Get(cache);
97  return cache;
98  }
99 
100  virtual bool Set( param_t push ) {
101  data = push;
102  status = NewData;
103  return true;
104  }
105 
106  virtual bool data_sample( param_t sample, bool reset ) {
107  if (!initialized || reset) {
108  Set(sample);
109  initialized = true;
110  return true;
111  } else {
112  return initialized;
113  }
114  }
115 
119  virtual value_t data_sample() const
120  {
121  return data;
122  }
123 
124  virtual void clear()
125  {
126  status = NoData;
127  }
128 
129  };
130 }}
131 
132 #endif
133 
virtual value_t Get() const
Get a copy of the data of this data object.
virtual value_t data_sample() const
Reads back a data sample.
DataObjectUnSync()
Construct an uninitialized DataObjectUnSync.
FlowStatus
Returns the status of a data flow read operation.
Definition: FlowStatus.hpp:56
DataObjectUnSync(param_t initial_value)
Construct a DataObjectUnSync with initial value.
virtual FlowStatus Get(reference_t pull, bool copy_old_data=true) const
Get a copy of the Data of this data object.
virtual bool Set(param_t push)
Set the data to a certain value.
A class which provides unprotected (not thread-safe) access to one typed element of data...
boost::call_traits< T >::param_type param_t
virtual bool data_sample(param_t sample, bool reset)
Provides a data sample to initialize this data object.
A DataObjectInterface implements multi-threaded read/write solutions.
boost::call_traits< T >::reference reference_t
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
virtual void clear()
Clears any data stored by this data object, so that any subsequent Get() without a new Set() will ret...