Orocos Real-Time Toolkit  2.8.3
Handle.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Wed Jan 18 14:11:38 CET 2006 Handle.hpp
3 
4  Handle.hpp - description
5  -------------------
6  begin : Wed January 18 2006
7  copyright : (C) 2006 Peter Soetens
8  email : peter.soetens@mech.kuleuven.be
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_CORELIB_SIGNAL_HANDLE_HPP
40 #define ORO_CORELIB_SIGNAL_HANDLE_HPP
41 
42 #include "internal/SignalBase.hpp"
43 
44 namespace RTT
45 {
67  {
68  private:
70  typedef sender_t::connection_t connection_t;
71  public:
75  Handle();
76 
77  Handle(connection_t conn);
78 
82  Handle(const Handle& hs);
83 
87  ~Handle();
88 
94  bool connect();
95 
101  bool disconnect();
102 
108  bool connected() const;
109 
114  operator bool() const;
115 
120  bool ready() const;
121  protected:
126  connection_t m_conn;
127  };
128 
138  :public Handle
139  {
140  ScopedHandle();
141  public:
142 
143  ScopedHandle(const Handle& hs);
144 
150  ~ScopedHandle();
151  };
152 
164  :public Handle
165  {
166  CleanupHandle();
167  public:
168 
169  CleanupHandle(const Handle& hs);
170 
176  ~CleanupHandle();
177  };
178 }
179 #endif
The base signal class which stores connection objects.
Definition: SignalBase.hpp:128
A scoped connection Handle of a (connected) slot which disconnects a slot from a signal in its destru...
Definition: Handle.hpp:137
#define RTT_API
Definition: rtt-config.h:97
A connection Handle of a (connected) slot which disconnects and cleans up (free all resources) the co...
Definition: Handle.hpp:163
connection_t m_conn
This is actually a smart pointer which always points to an existing connection object.
Definition: Handle.hpp:126
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:51
The Handle holds the information, and allows manipulation, of a connection between a internal::Signal...
Definition: Handle.hpp:66
ConnectionBase::shared_ptr connection_t
Definition: SignalBase.hpp:131