PropertyManager.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_PROPERTYMANAGER_H_
#define _MIRA_PROPERTYMANAGER_H_

#include <algorithm>

#ifndef Q_MOC_RUN
#include <boost/scoped_ptr.hpp>
#include <boost/algorithm/string/split.hpp>
#endif

#include <error/Exceptions.h>
#include <error/LoggingCore.h>

#include <serialization/adapters/std/list>
#include <serialization/PropertySerializer.h>

#include <platform/Typename.h>

namespace mira {


class PropertyManager
{
public:

    PropertyManager() : mRoot(new RootPropertyNode())
    {}

    template <typename T>
    void addObject(const char* name, T& object) {
        PropertySerializer s;
        s.reflectProperties(mRoot.get(), name, object);
    }

public:

    template <typename T>
    void setProperty(const std::string& name, const T& value,
                     const Duration& timeout = Duration::milliseconds(100))
    {
        TypedPropertyNode<T>* node = getPropertyNode<T>(name);
        if(node==NULL)
            MIRA_THROW(XLogical, "The property '" << name << "' does not exist");
        node->set(value, timeout);
    }

    template <typename T>
    T getProperty(const std::string& name) const
    {
        const TypedPropertyNode<T>* node = getPropertyNode<T>(name);
        if(node==NULL)
            MIRA_THROW(XLogical, "The property '" << name << "' does not exist");
        return node->get();
    }

public:

    const PropertyNode* getRootNode() const {
        return mRoot.get();
    }

    PropertyNode* getRootNode() {
        return mRoot.get();
    }

    const PropertyNode* getPropertyNode(const std::string& name) const {
        return mRoot->findChildNode(name);
    }

    PropertyNode* getPropertyNode(const std::string& name) {
        return mRoot->findChildNode(name);
    }

    template<typename T>
    const TypedPropertyNode<T>* getPropertyNode(const std::string& name) const
    {
        const PropertyNode* node = getPropertyNode(name);
        if (node == NULL)
            return NULL;
        if ( node->type() != typeName<T>() )
            MIRA_THROW(XBadCast, "The requested type '"
                    << typeName<T>() << "' for property '" << name
                    << "' does not match its real type '"
                    << node->type() << "'");
        return static_cast<const TypedPropertyNode<T>*>(node);
    }

    template<typename T>
    TypedPropertyNode<T>* getPropertyNode(const std::string& name)
    {
        const PropertyManager* This = this;
        return const_cast<TypedPropertyNode<T>*>(This->getPropertyNode<T>(name));
    }

private:

    boost::scoped_ptr<PropertyNode> mRoot;

};


} // namespace

#endif