RSB  0.17.0
CreateFunctions.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 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 <rsc/misc/langutils.h>
30 
31 #include "rsb/rsbexports.h"
32 
33 #include "Scope.h"
34 #include "ParticipantConfig.h"
35 #include "Factory.h"
36 
37 namespace rsb {
38 
53 template<class DataType>
55 createInformer(const Scope& scope,
56  const ParticipantConfig& config
57  = getFactory().getDefaultParticipantConfig(),
58  const std::string& dataType
60  return getFactory().createInformer<DataType>(scope, config, dataType);
61 }
62 
76 RSB_EXPORT InformerBasePtr crateInformerBase(const Scope& scope,
77  const std::string& dataType,
78  const ParticipantConfig& config
79  = getFactory().getDefaultParticipantConfig());
80 
92 RSB_EXPORT ListenerPtr createListener(const Scope& scope,
93  const ParticipantConfig& config
94  = getFactory().getDefaultParticipantConfig());
95 
110 RSB_EXPORT ReaderPtr createReader(const Scope& scope,
111  const ParticipantConfig& config
112  = getFactory().getDefaultParticipantConfig());
113 
122 RSB_EXPORT patterns::LocalServerPtr createLocalServer(const Scope& scope);
123 
132 RSB_EXPORT patterns::RemoteServerPtr createRemoteServer(const Scope& scope);
133 
134 }
patterns::LocalServerPtr createLocalServer(const Scope &scope)
Creates and returns a Server object that exposes methods under the Scope scope.
Informer< DataType >::Ptr createInformer(const Scope &scope, const ParticipantConfig &config=getFactory().getDefaultParticipantConfig(), const std::string &dataType=detail::TypeName< DataType >()())
Creates and returns a new Informer that publishes Event s under the Scope scope.
patterns::RemoteServerPtr createRemoteServer(const Scope &scope)
Creates and returns a RemoteServer object for the server at Scope scope.
Informer< DataType >::Ptr createInformer(const Scope &scope, const ParticipantConfig &config=getFactory().getDefaultParticipantConfig(), const std::string &dataType=detail::TypeName< DataType >()(), ParticipantPtr parent=ParticipantPtr())
Creates and returns a new Informer that publishes Event s under the Scope scope.
Definition: Factory.h:107
boost::shared_ptr< LocalServer > LocalServerPtr
Definition: LocalServer.h:489
boost::shared_ptr< Reader > ReaderPtr
Definition: Reader.h:106
Factory & getFactory()
Returns a factory for client-level RSB objects.
Definition: Factory.cpp:163
boost::shared_ptr< Listener > ListenerPtr
Definition: Listener.h:155
ReaderPtr createReader(const Scope &scope, const ParticipantConfig &config)
Creates and returns a new Reader object for Scope scope.
ListenerPtr createListener(const Scope &scope, const ParticipantConfig &config)
Creates and returns a new Listener for the Scope scope.
InformerBasePtr crateInformerBase(const Scope &scope, const string &dataType, const ParticipantConfig &config)
Creates and returns a new Informer that publishes Event s under the Scope scope.
boost::shared_ptr< Informer< T > > Ptr
Shared pointer type for this informer.
Definition: Informer.h:242
A class describing the configuration of Participant instances.
boost::shared_ptr< InformerBase > InformerBasePtr
Definition: Informer.h:217
boost::shared_ptr< RemoteServer > RemoteServerPtr
Definition: RemoteServer.h:311
Scope is a descriptor for a hierarchical channel of the unified bus.
Definition: Scope.h:46