RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Participant.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is part of the RSB project
4  *
5  * Copyright (C) 2011 Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <ostream>
30 
31 #include <boost/shared_ptr.hpp>
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/noncopyable.hpp>
34 
35 #include <rsc/misc/UUID.h>
36 #include <rsc/runtime/Printable.h>
37 
38 #include "rsb/rsbexports.h"
39 
40 namespace rsb {
41 
42 class ParticipantConfig;
43 class Scope;
44 typedef boost::shared_ptr<Scope> ScopePtr;
45 
57 class RSB_EXPORT Participant: public virtual rsc::runtime::Printable,
58  public boost::noncopyable {
59 public:
60 
61  virtual ~Participant();
62 
63  void printContents(std::ostream& stream) const;
64 
70  rsc::misc::UUID getId() const;
71 
77  ScopePtr getScope() const;
78 
84  ParticipantConfig getConfig() const;
85 
86 protected:
87 
88  Participant(const Scope& scope, const ParticipantConfig& config);
89 
90 private:
91 
92  class Impl;
93  boost::scoped_ptr<Impl> d;
94 
95 };
96 
97 typedef boost::shared_ptr<Participant> ParticipantPtr;
98 
99 }
boost::shared_ptr< Scope > ScopePtr
Definition: Event.h:49
Objects of this class participate in the exchange of notifications on one channel of the bus...
Definition: Participant.h:57
boost::shared_ptr< Participant > ParticipantPtr
Definition: Participant.h:97
A class describing the configuration of Participant instances.
boost::scoped_ptr< Impl > d
Definition: Participant.h:92
Scope is a descriptor for a hierarchical channel of the unified bus.
Definition: Scope.h:46