Scope.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project.
 *
 * Copyright (C) 2011 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <string>
#include <vector>
#include <ostream>

#include <boost/shared_ptr.hpp>
#include <boost/operators.hpp>

#include "rsb/rsbexports.h"

namespace rsb {

class RSB_EXPORT Scope: boost::totally_ordered<Scope> {
public:

    Scope(const std::string& scope);

    Scope(const char* scope);

    Scope();

    virtual ~Scope();

    const std::vector<std::string>& getComponents() const;

    const std::string& toString() const;

    Scope concat(const Scope& childScope) const;

    bool isSubScopeOf(const Scope& other) const;

    bool isSuperScopeOf(const Scope& other) const;

    std::vector<Scope> superScopes(const bool& includeSelf = false) const;

    bool operator==(const Scope& other) const;
    bool operator<(const Scope& other) const;

    static const char COMPONENT_SEPARATOR;
private:

    void updateStringCache();

    std::string scopestring;
    std::vector<std::string> components;

};

typedef boost::shared_ptr<Scope> ScopePtr;

RSB_EXPORT std::ostream& operator<<(std::ostream& stream, const Scope& scope);

}