Orocos Real-Time Toolkit  2.6.0
BufferInterface.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 10 16:16:57 CEST 2002  BufferInterface.hpp
00003 
00004                         BufferInterface.hpp -  description
00005                            -------------------
00006     begin                : Thu October 10 2002
00007     copyright            : (C) 2002 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 ORO_CORELIB_BUFFERINTERFACE_HPP
00039 #define ORO_CORELIB_BUFFERINTERFACE_HPP
00040 
00041 #include "BufferBase.hpp"
00042 #include <boost/shared_ptr.hpp>
00043 #include <boost/call_traits.hpp>
00044 #include <vector>
00045 
00046 namespace RTT
00047 { namespace base {
00048 
00054     template<class T>
00055     class BufferInterface :
00056         public BufferBase
00057     {
00058     public:
00059         typedef T value_t;
00060         typedef BufferBase::size_type size_type;
00061 
00062         typedef boost::shared_ptr< BufferInterface<T> > shared_ptr;
00063         typedef typename boost::call_traits<T>::param_type param_t;
00064         typedef typename boost::call_traits<T>::reference reference_t;
00065 
00066         virtual ~BufferInterface()
00067         {}
00068 
00076         virtual bool Pop( reference_t item) = 0;
00077 
00086         virtual size_type Pop( std::vector<value_t>& items ) = 0;
00087 
00098     virtual value_t* PopWithoutRelease() = 0;
00099 
00104     virtual void Release(value_t *item) = 0;
00105     
00113         virtual bool Push( param_t item) = 0;
00114 
00122         virtual size_type Push( const std::vector<value_t>& items ) = 0;
00123 
00133         virtual void data_sample( const T& sample ) = 0;
00134 
00138         virtual T data_sample() const = 0;
00139     };
00140 }}
00141 
00142 #endif