Orocos Real-Time Toolkit  2.9.0
ConnInputEndPoint.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:08 CEST 2009 ConnInputEndPoint.hpp
3 
4  ConnInputEndPoint.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_CONN_INPUT_ENDPOINT_HPP
40 #define ORO_CONN_INPUT_ENDPOINT_HPP
41 
42 #include "Channels.hpp"
43 
44 namespace RTT
45 { namespace internal {
46 
50  template<typename T>
52  {
53  private:
54  OutputPort<T>* port;
55 
56  public:
58  typedef boost::intrusive_ptr<ConnInputEndpoint<T> > shared_ptr;
59 
61  : port(port) { }
62 
64  {}
65 
67  return true;
68  }
69 
70  using Base::disconnect;
71 
72  virtual bool disconnect(const base::ChannelElementBase::shared_ptr& channel, bool forward)
73  {
74  OutputPort<T>* port = this->port;
75  if (port && channel && !forward)
76  {
77  port->getManager()->removeConnection(channel.get(), /* disconnect = */ false);
78  }
79 
80  // Call the base class: it does the common cleanup
81  if (!Base::disconnect(channel, forward)) {
82  return false;
83  }
84 
85  // If this was the last connection, remove the buffer, too.
86  // For forward == false this was already done by the base class.
87  if (!this->connected() && forward) {
88  this->disconnect(false);
89  }
90 
91  return true;
92  }
93 
94  virtual base::PortInterface* getPort() const {
95  return this->port;
96  }
97 
99  {
100  return this;
101  }
102 
104  {
105  return this->getInput();
106  }
107 
109  {
111  if (buffer) {
112  return buffer;
113  } else {
114  return this;
115  }
116  }
117 
118  std::string getElementName() const {
119  return std::string("ConnInputEndpoint");
120  }
121 
122  };
123 
124 }}
125 
126 #endif
127 
boost::intrusive_ptr< ChannelElement< T > > shared_ptr
This is a channel element that represents the input endpoint of a connection, i.e.
virtual base::PortInterface * getPort() const
Gets the port this channel element is connected to.
boost::intrusive_ptr< ConnInputEndpoint< T > > shared_ptr
virtual bool inputReady(base::ChannelElementBase::shared_ptr const &)
This is called by an input port when it is ready to receive data.
virtual bool disconnect(ChannelElementBase::shared_ptr const &channel, bool forward=false)
Overridden implementation of ChannelElementBase::disconnect(forward, channel).
virtual internal::ConnectionManager * getManager()
Returns the connection manager of this port (if any).
virtual bool disconnect(const base::ChannelElementBase::shared_ptr &channel, bool forward)
Overridden implementation of ChannelElementBase::disconnect(forward, channel).
virtual base::ChannelElement< T >::shared_ptr getSharedBuffer()
A typed version of MultipleOutputsChannelElementBase.
boost::intrusive_ptr< ChannelElementBase > shared_ptr
virtual base::ChannelElementBase::shared_ptr getInputEndPoint()
Returns the first input channel element of this connection.
A component&#39;s data output port.
Definition: OutputPort.hpp:70
std::string getElementName() const
Returns the class name of this element.
ConnInputEndpoint(OutputPort< T > *port)
base::ChannelElement< T >::shared_ptr getWriteEndpoint()
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
base::MultipleOutputsChannelElement< T > Base
The base class of every data flow port.
virtual bool connected()
Returns true, if this channel element has at least one output, independent of whether is has an input...