Orocos Real-Time Toolkit  2.6.0
DataObjectLocked.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Mon Jan 19 14:11:26 CET 2004  DataObjectLocked.hpp
00003 
00004                         DataObjectLocked.hpp -  description
00005                            -------------------
00006     begin                : Mon January 19 2004
00007     copyright            : (C) 2004 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.ac.be
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 #ifndef CORELIB_DATAOBJECT_LOCKED_HPP
00039 #define CORELIB_DATAOBJECT_LOCKED_HPP
00040 
00041 
00042 #include "../os/MutexLock.hpp"
00043 #include "DataObjectInterface.hpp"
00044 
00045 namespace RTT
00046 { namespace base {
00047 
00056     template<class T>
00057     class DataObjectLocked
00058         : public DataObjectInterface<T>
00059     {
00060         mutable os::Mutex lock;
00061 
00065         T data;
00066     public:
00072         DataObjectLocked( const T& initial_value = T() )
00073             : data(initial_value) {}
00074 
00078         typedef T DataType;
00079 
00080         virtual void Get( DataType& pull ) const { os::MutexLock locker(lock); pull = data; }
00081 
00082         virtual DataType Get() const { DataType cache;  Get(cache); return cache; }
00083 
00084         virtual void Set( const DataType& push ) { os::MutexLock locker(lock); data = push; }
00085 
00086         virtual void data_sample( const DataType& sample ) {
00087             Set(sample);
00088         }
00089     };
00090 }}
00091 
00092 #endif
00093