Scope is a descriptor for a hierarchical channel of the unified bus. More...

#include <Scope.h>

Collaboration diagram for rsb::Scope:

Public Member Functions
	Scope (const std::string &scope)
	Constructs scope from a string syntax.
	Scope (const char *scope)
	Constructs scope from a string syntax.
	Scope ()
	Creates a scope representing "/".
virtual	~Scope ()
	Destructor.
const std::vector< std::string > &	getComponents () const
	Returns all components of the scope as an ordered list.
const std::string &	toString () const
	Reconstructs a fully formal string representation of the scope with leading an trailing slashes.
Scope	concat (const Scope &childScope) const
	Creates a new scope that is a sub-scope of this one with the subordinated scope described by the given argument.
bool	isSubScopeOf (const Scope &other) const
	Tests whether this scope is a sub-scope of the given other scope, which means that the other scope is a prefix of this scope.
bool	isSuperScopeOf (const Scope &other) const
	Inverse operation of isSubScopeOf.
std::vector< Scope >	superScopes (const bool &includeSelf=false) const
	Generates all super scopes of this scope including the root scope "/".
bool	operator== (const Scope &other) const
bool	operator< (const Scope &other) const

Static Public Attributes
static const char	COMPONENT_SEPARATOR = '/'

Private Member Functions
void	updateStringCache ()
	Updates the contents of `scopestring` based on `components`.

Private Attributes
std::string	scopestring
std::vector< std::string >	components

Detailed Description

Scope is a descriptor for a hierarchical channel of the unified bus.

It can be described through a syntax like "/a/parent/scope/".

Author: jwienke

Definition at line 46 of file Scope.h.

Constructor & Destructor Documentation

rsb::Scope::Scope ( const std::string & scope )

Constructs scope from a string syntax.

Parameters

scope string representation of the desired scope

Exceptions

std::invalid_argument invalid syntax

Definition at line 115 of file Scope.cpp.

References components, scopestring, and rsb::verifyAndSplit().

Here is the call graph for this function:

rsb::Scope::Scope ( const char * scope )

Constructs scope from a string syntax.

Parameters

scope string representation of the desired scope

Exceptions

std::invalid_argument invalid syntax

Definition at line 123 of file Scope.cpp.

References components, scopestring, and rsb::verifyAndSplit().

Here is the call graph for this function:

rsb::Scope::Scope ( )

Creates a scope representing "/".

Use this wisely!

Definition at line 131 of file Scope.cpp.

rsb::Scope::~Scope ( )

virtual

Destructor.

Definition at line 135 of file Scope.cpp.

Member Function Documentation

Scope rsb::Scope::concat ( const Scope & childScope ) const

Creates a new scope that is a sub-scope of this one with the subordinated scope described by the given argument.

E.g. "/this/is/".concat("/a/test/") results in "/this/is/a/test".

Parameters

childScope child to concatenate to the current scope for forming a sub-scope

Returns: new scope instance representing the created sub-scope

Definition at line 146 of file Scope.cpp.

References components, and updateStringCache().

Referenced by rsb::patterns::RemoteServer::getMethodSet(), and rsb::patterns::Server::registerMethod().

Here is the call graph for this function:

Here is the caller graph for this function:

const vector< string > & rsb::Scope::getComponents ( ) const

Returns all components of the scope as an ordered list.

Components are the names between the separator character '/'. The first entry in the list is the highest level of hierarchy. The scope '/' returns an empty list.