RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Scope.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of the RSB project.
4  *
5  * Copyright (C) 2011 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot 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 <string>
30 #include <vector>
31 #include <ostream>
32 
33 #include <boost/shared_ptr.hpp>
34 #include <boost/operators.hpp>
35 
36 #include "rsb/rsbexports.h"
37 
38 namespace rsb {
39 
46 class RSB_EXPORT Scope: boost::totally_ordered<Scope> {
47 public:
48 
55  Scope(const std::string& scope);
56 
63  Scope(const char* scope);
64 
68  Scope();
69 
73  virtual ~Scope();
74 
84  const std::vector<std::string>& getComponents() const;
85 
92  const std::string& toString() const;
93 
103  Scope concat(const Scope& childScope) const;
104 
114  bool isSubScopeOf(const Scope& other) const;
115 
123  bool isSuperScopeOf(const Scope& other) const;
124 
134  std::vector<Scope> superScopes(const bool& includeSelf = false) const;
135 
136  bool operator==(const Scope& other) const;
137  bool operator<(const Scope& other) const;
138 
139  static const char COMPONENT_SEPARATOR;
140 private:
141 
147  void updateStringCache();
148 
149  std::string scopestring;
150  std::vector<std::string> components;
151 
152 };
153 
154 typedef boost::shared_ptr<Scope> ScopePtr;
155 
156 RSB_EXPORT std::ostream& operator<<(std::ostream& stream, const Scope& scope);
157 
158 }
boost::shared_ptr< Scope > ScopePtr
Definition: Event.h:49
std::string scopestring
Definition: Scope.h:149
ostream & operator<<(ostream &stream, const MetaData &meta)
Definition: MetaData.cpp:253
static const char COMPONENT_SEPARATOR
Definition: Scope.h:139
std::vector< std::string > components
Definition: Scope.h:150
Scope is a descriptor for a hierarchical channel of the unified bus.
Definition: Scope.h:46