Orocos Real-Time Toolkit  2.8.3
ChannelElementBase.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:07 CEST 2009 ChannelElementBase.hpp
3 
4  ChannelElementBase.hpp - description
5  -------------------
6  begin : Thu October 22 2009
7  copyright : (C) 2009 Sylvain Joyeux
8  email : sylvain.joyeux@m4x.org
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 
39 #ifndef ORO_CHANNEL_BASE_HPP
40 #define ORO_CHANNEL_BASE_HPP
41 
42 #include "../os/oro_arch.h"
43 #include <utility>
44 #include <boost/intrusive_ptr.hpp>
45 #include <boost/call_traits.hpp>
46 
47 #include <rtt/os/Mutex.hpp>
48 #include "rtt-base-fwd.hpp"
49 #include "../internal/rtt-internal-fwd.hpp"
50 
51 namespace RTT { namespace base {
52 
61  {
62  public:
63  typedef boost::intrusive_ptr<ChannelElementBase> shared_ptr;
64 
65  private:
66  oro_atomic_t refcount;
69 
70  shared_ptr input;
71  shared_ptr output;
72 
73  RTT::os::Mutex inout_lock;
74 
75  protected:
77  void ref();
80  void deref();
81 
82  public:
89  virtual ~ChannelElementBase();
90 
95  void removeInput();
104 
111  ChannelElementBase::shared_ptr getInputEndPoint();
112 
113 
117  ChannelElementBase::shared_ptr getOutput();
118 
125  ChannelElementBase::shared_ptr getOutputEndPoint();
126 
134  void setOutput(shared_ptr output);
135 
141  virtual bool signal();
142 
150  virtual bool inputReady();
151 
158  virtual void clear();
159 
164  virtual void disconnect(bool forward);
165 
171  virtual PortInterface* getPort() const;
172 
178  virtual internal::ConnID* getConnID() const;
179 
188  virtual bool isRemoteElement() const;
189 
200  virtual std::string getRemoteURI() const;
201 
207  virtual std::string getLocalURI() const;
208 
216  virtual std::string getElementName() const;
217  };
218 
221 
222 }}
223 
224 #endif
225 
void RTT_API intrusive_ptr_add_ref(ChannelElementBase *e)
#define RTT_API
Definition: rtt-config.h:97
boost::intrusive_ptr< ChannelElementBase > shared_ptr
void RTT_API intrusive_ptr_release(ChannelElementBase *e)
This class is used in places where a permanent representation of a reference to a connection is neede...
Definition: ConnID.hpp:58
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
In the data flow implementation, a channel is created by chaining ChannelElementBase objects...
The base class of every data flow port.
Structure that contains an int for atomic operations.
Definition: oro_arch.h:10