Orocos Real-Time Toolkit  2.9.0
BufferInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 10 16:16:57 CEST 2002 BufferInterface.hpp
3 
4  BufferInterface.hpp - description
5  -------------------
6  begin : Thu October 10 2002
7  copyright : (C) 2002 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 ORO_CORELIB_BUFFERINTERFACE_HPP
39 #define ORO_CORELIB_BUFFERINTERFACE_HPP
40 
41 #include "BufferBase.hpp"
42 #include "../FlowStatus.hpp"
43 #include <boost/shared_ptr.hpp>
44 #include <boost/call_traits.hpp>
45 #include <vector>
46 
47 namespace RTT
48 { namespace base {
49 
55  template<class T>
57  public BufferBase
58  {
59  public:
60  typedef T value_t;
62 
63  typedef boost::shared_ptr< BufferInterface<T> > shared_ptr;
64  typedef typename boost::call_traits<T>::param_type param_t;
65  typedef typename boost::call_traits<T>::reference reference_t;
66 
67  virtual ~BufferInterface()
68  {}
69 
77  virtual FlowStatus Pop( reference_t item) = 0;
78 
87  virtual size_type Pop( std::vector<value_t>& items ) = 0;
88 
99  virtual value_t* PopWithoutRelease() = 0;
100 
105  virtual void Release(value_t *item) = 0;
106 
114  virtual bool Push( param_t item) = 0;
115 
123  virtual size_type Push( const std::vector<value_t>& items ) = 0;
124 
137  virtual bool data_sample( param_t sample, bool reset = true ) = 0;
138 
142  virtual value_t data_sample() const = 0;
143  };
144 }}
145 
146 #endif
virtual FlowStatus Pop(reference_t item)=0
Read the oldest value from the buffer.
boost::call_traits< T >::reference reference_t
A Buffer is an object which is used to store (Push) and retrieve (Pop) values from.
FlowStatus
Returns the status of a data flow read operation.
Definition: FlowStatus.hpp:56
virtual bool Push(param_t item)=0
Write a single value to the buffer.
boost::call_traits< T >::param_type param_t
virtual value_t data_sample() const =0
Reads back a data sample.
virtual void Release(value_t *item)=0
Releases the pointer.
virtual value_t * PopWithoutRelease()=0
Returns a pointer to the first element in the buffer.
BufferBase::size_type size_type
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
Any Buffer has a capacity, size and can be empty or full.
Definition: BufferBase.hpp:53
boost::shared_ptr< BufferInterface< T > > shared_ptr