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/ConnectionManager.hpp"
46 #include "../internal/ConnID.hpp"
47 #include "ChannelElementBase.hpp"
48 #include "../types/rtt-types-fwd.hpp"
49 #include "../os/Mutex.hpp"
50 #include "../rtt-fwd.hpp"
51 
52 namespace RTT
53 { namespace base {
54 
59  class RTT_API PortInterface
60  {
61  std::string name;
62  std::string fullName;
63  std::string mdesc;
64 
65  void updateFullName();
66 
67  protected:
72 
73  PortInterface(const std::string& name);
74 
75  public:
76  virtual ~PortInterface();
77 
81  virtual internal::ConnID* getPortID() const;
82 
86  const std::string& getName() const { return name; }
87 
92  const std::string& getFullName() const { return fullName; }
93 
100  bool setName(const std::string& name);
101 
106  const std::string& getDescription() const { return mdesc; }
107 
113  PortInterface& doc(const std::string& desc);
114 
115 
117  virtual bool connected() const = 0;
118 
120  virtual bool connectedTo(PortInterface* port);
121 
123  virtual const types::TypeInfo* getTypeInfo() const = 0;
124 
126  virtual void disconnect() = 0;
127 
132  virtual bool disconnect(PortInterface* port) = 0;
133 
137  virtual bool isLocal() const;
138 
142  virtual int serverProtocol() const;
143 
150  virtual PortInterface* clone() const = 0;
151 
159  virtual PortInterface* antiClone() const = 0;
160 
165  virtual Service* createPortObject();
166 
173  virtual bool connectTo(PortInterface* other, ConnPolicy const& policy) = 0;
174 
181  virtual bool connectTo(PortInterface* other) = 0;
182 
191  virtual bool createStream(ConnPolicy const& policy) = 0;
192 
196  virtual bool createConnection(internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const& policy = ConnPolicy()) = 0;
197 
202  virtual bool addConnection(internal::ConnID* cid, ChannelElementBase::shared_ptr channel,
203  ConnPolicy const& policy = ConnPolicy()) = 0;
204 
210  virtual bool removeConnection(internal::ConnID* cid);
211 
218  void setInterface(DataFlowInterface* iface);
219 
224  DataFlowInterface* getInterface() const;
225 
235  virtual internal::ConnectionManager* getManager() { return &cmanager; }
236 
242  virtual ChannelElementBase* getEndpoint() const = 0;
243 
247  virtual internal::SharedConnectionBase::shared_ptr getSharedConnection() const;
248  };
249 
250 }}
251 
252 #endif
boost::intrusive_ptr< SharedConnectionBase > shared_ptr
const std::string & getName() const
virtual internal::ConnectionManager * getManager()
os::MutexRecursive connection_lock
const std::string & getDescription() const
boost::intrusive_ptr< ChannelElementBase > shared_ptr
internal::ConnectionManager cmanager
DataFlowInterface * iface
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:53
An object oriented wrapper around a recursive mutex.
Definition: Mutex.hpp:218
const std::string & getFullName() const


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