Orocos Real-Time Toolkit  2.8.3
PortInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:07 CEST 2009 PortInterface.hpp
3 
4  PortInterface.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_EXECUTION_PORT_INTERFACE_HPP
40 #define ORO_EXECUTION_PORT_INTERFACE_HPP
41 
42 #include <string>
43 #include "../internal/rtt-internal-fwd.hpp"
44 #include "../ConnPolicy.hpp"
45 #include "../internal/ConnID.hpp"
46 #include "ChannelElementBase.hpp"
47 #include "../types/rtt-types-fwd.hpp"
48 #include "../rtt-fwd.hpp"
49 
50 namespace RTT
51 { namespace base {
52 
58  {
59  std::string name;
60  std::string mdesc;
61  protected:
63 
64  PortInterface(const std::string& name);
65 
66  public:
67  virtual ~PortInterface() {}
68 
72  virtual internal::ConnID* getPortID() const;
73 
77  const std::string& getName() const { return name; }
78 
85  bool setName(const std::string& name);
86 
91  const std::string& getDescription() const { return mdesc; }
92 
98  PortInterface& doc(const std::string& desc);
99 
100 
102  virtual bool connected() const = 0;
103 
105  virtual const types::TypeInfo* getTypeInfo() const = 0;
106 
108  virtual void disconnect() = 0;
109 
114  virtual bool disconnect(PortInterface* port) = 0;
115 
119  virtual bool isLocal() const;
120 
124  virtual int serverProtocol() const;
125 
132  virtual PortInterface* clone() const = 0;
133 
141  virtual PortInterface* antiClone() const = 0;
142 
147  virtual Service* createPortObject();
148 
155  virtual bool connectTo(PortInterface* other, ConnPolicy const& policy) = 0;
156 
163  virtual bool connectTo(PortInterface* other) = 0;
164 
173  virtual bool createStream(ConnPolicy const& policy) = 0;
174 
179  virtual bool addConnection(internal::ConnID* cid, ChannelElementBase::shared_ptr channel_input, ConnPolicy const& policy = ConnPolicy() ) = 0;
180 
186  virtual bool removeConnection(internal::ConnID* cid) = 0;
187 
194  void setInterface(DataFlowInterface* iface);
199  DataFlowInterface* getInterface() const;
200 
210  virtual const internal::ConnectionManager* getManager() const = 0;
211 };
212 
213 }}
214 
215 #endif
The Interface of a TaskContext which exposes its data-flow ports.
const std::string & getName() const
Get the name of this Port.
Manages connections between ports.
#define RTT_API
Definition: rtt-config.h:97
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:92
This class allows storage and retrieval of operations, ports, attributes and properties provided by a...
Definition: Service.hpp:93
const std::string & getDescription() const
Get the documentation of this port.
A class for representing a user type, and which can build instances of that type. ...
Definition: TypeInfo.hpp:66
boost::intrusive_ptr< ChannelElementBase > shared_ptr
DataFlowInterface * iface
This class is used in places where a permanent representation of a reference to a connection is neede...
Definition: ConnID.hpp:58
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:51
The base class of every data flow port.