RSB  0.17.0
Reader.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is part of the RSB project
4  *
5  * Copyright (C) 2011, 2014, 2015 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 <vector>
30 #include <set>
31 
32 #include <boost/shared_ptr.hpp>
33 
34 #include <rsc/logging/Logger.h>
35 
36 #include "Scope.h"
37 #include "Event.h"
38 #include "Participant.h"
41 
42 namespace rsb {
43 
62 class RSB_EXPORT Reader: public Participant {
63 public:
76  Reader(const std::vector<transport::InPullConnectorPtr>& connectors,
77  const Scope& scope,
78  const ParticipantConfig& config);
79 
80  // Overrides method in Participant.
81  virtual std::string getKind() const;
82 
83  // Overrides method in Participant.
84  virtual const std::set<std::string> getTransportURLs() const;
85 
99  EventPtr read(bool block = true);
100 private:
101  rsc::logging::LoggerPtr logger;
102 
104 };
105 
106 typedef boost::shared_ptr<Reader> ReaderPtr;
107 
108 }
boost::shared_ptr< InRouteConfigurator > InRouteConfiguratorPtr
rsc::logging::LoggerPtr logger
Definition: Reader.h:101
eventprocessing::InRouteConfiguratorPtr configurator
Definition: Reader.h:103
Objects of this class participate in the exchange of notifications on one channel of the bus...
Definition: Participant.h:65
boost::shared_ptr< Reader > ReaderPtr
Definition: Reader.h:106
A Reader receives events published by a informers by participating in a channel with a suitable scope...
Definition: Reader.h:62
A class describing the configuration of Participant instances.
boost::shared_ptr< Event > EventPtr
Definition: Event.h:264
Scope is a descriptor for a hierarchical channel of the unified bus.
Definition: Scope.h:46