Orocos Real-Time Toolkit  2.8.3
DataObjectLocked.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Mon Jan 19 14:11:26 CET 2004 DataObjectLocked.hpp
3 
4  DataObjectLocked.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_DATAOBJECT_LOCKED_HPP
39 #define CORELIB_DATAOBJECT_LOCKED_HPP
40 
41 
42 #include "../os/MutexLock.hpp"
43 #include "DataObjectInterface.hpp"
44 
45 namespace RTT
46 { namespace base {
47 
56  template<class T>
58  : public DataObjectInterface<T>
59  {
60  mutable os::Mutex lock;
61 
65  T data;
66  public:
72  DataObjectLocked( const T& initial_value = T() )
73  : data(initial_value) {}
74 
78  typedef T DataType;
79 
80  virtual void Get( DataType& pull ) const { os::MutexLock locker(lock); pull = data; }
81 
82  virtual DataType Get() const { DataType cache; Get(cache); return cache; }
83 
84  virtual void Set( const DataType& push ) { os::MutexLock locker(lock); data = push; }
85 
86  virtual void data_sample( const DataType& sample ) {
87  Set(sample);
88  }
89  };
90 }}
91 
92 #endif
93 
T DataType
The type of the data.
virtual void Set(const DataType &push)
Set the data to a certain value.
virtual void data_sample(const DataType &sample)
Provides a data sample to initialize this data object.
A DataObjectInterface implements multi-threaded read/write solutions.
A class which provides locked/protected access to one typed element of data.
virtual void Get(DataType &pull) const
Get a copy of the Data of this data object.
An object oriented wrapper around a non recursive mutex.
Definition: Mutex.hpp:82
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:51
virtual DataType Get() const
Get a copy of the data of this data object.
DataObjectLocked(const T &initial_value=T())
Construct a DataObjectLocked by name.
MutexLock is a scope based Monitor, protecting critical sections with a Mutex object through locking ...
Definition: MutexLock.hpp:51