InputPortInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:07 CEST 2009 InputPortInterface.hpp
3 
4  InputPortInterface.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_INPUT_PORT_INTERFACE_HPP
40 #define ORO_INPUT_PORT_INTERFACE_HPP
41 
42 #include <string>
43 #include "PortInterface.hpp"
44 #include "ChannelElement.hpp"
45 #include "../internal/rtt-internal-fwd.hpp"
46 #include "../internal/ConnectionManager.hpp"
47 #ifdef ORO_SIGNALLING_PORTS
48 #include "../internal/Signal.hpp"
49 #endif
50 #include "../base/DataSourceBase.hpp"
51 
52 namespace RTT
53 { namespace base {
54 
55 
60  class RTT_API InputPortInterface : public PortInterface
61  {
62 #ifdef ORO_SIGNALLING_PORTS
63  public:
64  typedef internal::Signal<void(PortInterface*)> NewDataOnPortEvent;
65  typedef NewDataOnPortEvent::SlotFunction SlotFunction;
66 #endif
67 
68  protected:
70 #ifdef ORO_SIGNALLING_PORTS
71  NewDataOnPortEvent* new_data_on_port_event;
72 #else
77  void signal();
78 #endif
79 
80  void traceRead(RTT::FlowStatus status);
82  public:
83 
84  InputPortInterface(std::string const& name, ConnPolicy const& default_policy = ConnPolicy());
85 
86  virtual ~InputPortInterface();
87 
91  virtual void clear() = 0;
92 
93  ConnPolicy getDefaultPolicy() const;
94 
95  virtual bool addConnection(internal::ConnID* port_id, ChannelElementBase::shared_ptr channel, ConnPolicy const& policy);
96 
100  virtual DataSourceBase* getDataSource() = 0;
101 
107  virtual FlowStatus read(DataSourceBase::shared_ptr source, bool copy_old_data = true);
108 
112  virtual void disconnect();
113 
117  virtual bool disconnect(PortInterface* port);
118 
119 
121  virtual bool connected() const;
122 
123 #ifdef ORO_SIGNALLING_PORTS
124 
127  NewDataOnPortEvent* getNewDataOnPortEvent();
128 #else
129 
132  void signalInterface(bool true_false);
133 #endif
134 
135  virtual bool connectTo(PortInterface* other, ConnPolicy const& policy);
136 
137  virtual bool connectTo(PortInterface* other);
138 
142  virtual bool createConnection( internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const& policy = ConnPolicy() );
143 
149  virtual base::ChannelElementBase::shared_ptr buildRemoteChannelOutput(
150  base::OutputPortInterface& output_port,
151  types::TypeInfo const* type_info,
152  base::InputPortInterface& input, const ConnPolicy& policy);
153  };
154 
155 }}
156 
157 #endif
boost::intrusive_ptr< SharedConnectionBase > shared_ptr
The base class for all internal data representations.
FlowStatus
Definition: FlowStatus.hpp:56
boost::intrusive_ptr< ChannelElementBase > shared_ptr
boost::intrusive_ptr< DataSourceBase > shared_ptr
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:53


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:25