Orocos Real-Time Toolkit  2.9.0
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 
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 
81  public:
82 
83  InputPortInterface(std::string const& name, ConnPolicy const& default_policy = ConnPolicy());
84 
85  virtual ~InputPortInterface();
86 
90  virtual void clear() = 0;
91 
92  ConnPolicy getDefaultPolicy() const;
93 
94  virtual bool addConnection(internal::ConnID* port_id, ChannelElementBase::shared_ptr channel, ConnPolicy const& policy);
95 
99  virtual DataSourceBase* getDataSource() = 0;
100 
106  virtual FlowStatus read(DataSourceBase::shared_ptr source, bool copy_old_data = true);
107 
111  virtual void disconnect();
112 
116  virtual bool disconnect(PortInterface* port);
117 
118 
120  virtual bool connected() const;
121 
122 #ifdef ORO_SIGNALLING_PORTS
123 
126  NewDataOnPortEvent* getNewDataOnPortEvent();
127 #else
128 
131  void signalInterface(bool true_false);
132 #endif
133 
134  virtual bool connectTo(PortInterface* other, ConnPolicy const& policy);
135 
136  virtual bool connectTo(PortInterface* other);
137 
141  virtual bool createConnection( internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const& policy = ConnPolicy() );
142 
148  virtual base::ChannelElementBase::shared_ptr buildRemoteChannelOutput(
149  base::OutputPortInterface& output_port,
150  types::TypeInfo const* type_info,
151  base::InputPortInterface& input, const ConnPolicy& policy);
152  };
153 
154 }}
155 
156 #endif
The base class of the InputPort.
boost::intrusive_ptr< SharedConnectionBase > shared_ptr
The base class for all internal data representations.
FlowStatus
Returns the status of a data flow read operation.
Definition: FlowStatus.hpp:56
#define RTT_API
Definition: rtt-config.h:97
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:107
The base class of each OutputPort.
A class for representing a user type, and which can build instances of that type. ...
Definition: TypeInfo.hpp:67
boost::intrusive_ptr< ChannelElementBase > shared_ptr
This class is used in places where a permanent representation of a reference to a connection is neede...
Definition: ConnID.hpp:58
boost::intrusive_ptr< DataSourceBase > shared_ptr
Use this type to store a pointer to a DataSourceBase.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
The base class of every data flow port.
Very lightweight wrapper around the signalN classes that allows signals to be created where the numbe...