Orocos Real-Time Toolkit  2.9.0
BufferBase.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_BUFFERBASE_HPP
39 #define ORO_CORELIB_BUFFERBASE_HPP
40 
41 #include <boost/shared_ptr.hpp>
42 #include "../rtt-config.h"
43 #include "../rtt-fwd.hpp"
44 
45 namespace RTT
46 { namespace base {
47 
54  {
55  public:
56  typedef int size_type;
57  typedef boost::shared_ptr< BufferBase > shared_ptr;
58 
59  class Options {
60  private:
61  bool circular_;
62  int max_threads_;
63  bool multiple_writers_;
64  bool multiple_readers_;
65  public:
66  Options();
67  Options(bool circular); // implicit conversion from bool for backwards-compatibility only
68  Options(const ConnPolicy &policy);
69  bool circular() const { return circular_; }
70  Options &circular(bool value) { circular_ = value; return *this; }
71  unsigned int max_threads() const { return max_threads_; }
72  Options &max_threads(unsigned int value) { max_threads_ = value; return *this; }
73  bool multiple_writers() const { return multiple_writers_; }
74  Options &multiple_writers(bool value) { multiple_writers_ = value; return *this; }
75  bool multiple_readers() const { return multiple_readers_; }
76  Options &multiple_readers(bool value) { multiple_readers_ = value; return *this; }
77  };
78 
79  virtual ~BufferBase();
80 
88  virtual size_type capacity() const = 0;
89 
97  virtual size_type size() const = 0;
98 
105  virtual bool empty() const = 0;
106 
113  virtual bool full() const = 0;
114 
120  virtual void clear() = 0;
121 
125  virtual size_type dropped() const = 0;
126  };
127 }}
128 
129 #endif
#define RTT_API
Definition: rtt-config.h:97
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:107
Options & circular(bool value)
Definition: BufferBase.hpp:70
Options & multiple_readers(bool value)
Definition: BufferBase.hpp:76
unsigned int max_threads() const
Definition: BufferBase.hpp:71
boost::shared_ptr< BufferBase > shared_ptr
Definition: BufferBase.hpp:57
Options & max_threads(unsigned int value)
Definition: BufferBase.hpp:72
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
Options & multiple_writers(bool value)
Definition: BufferBase.hpp:74