PropertyTree.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.
 */

#include <serialization/PropertyNode.h>
#include <serialization/adapters/std/vector>

#ifndef _MIRA_PROPERTYTREE_H_
#define _MIRA_PROPERTYTREE_H_

namespace mira {


class PropertyTree
{
private:

    struct Node : public PropertyNodeInfo
    {
        Node() {}
        Node(const PropertyNodeInfo& info) : PropertyNodeInfo(info) {}

        template<typename Reflector>
        void reflect(Reflector& r)
        {
            MIRA_REFLECT_BASE(r, PropertyNodeInfo);
            r.member("Children", children, "");
        }

        std::list<Node> children;
    };

    void createChildren(Node& node, PropertyNode* pnode)
    {
        node.children.clear();
        foreach(PropertyNode* p, pnode->children())
        {
            node.children.push_back(*p);
            createChildren(node.children.back(),p);
        }
    }

    template <typename PropertyNodeType>
    void generateChildren(PropertyNodeType* pnode, const Node& node) const
    {
        assert(pnode!=NULL);
        foreach(const Node& c, node.children)
        {
            PropertyNodeType* cn = new PropertyNodeType(c);
            pnode->addChild(cn);
            generateChildren<PropertyNodeType>(cn, c);
        }
    }

public:

    PropertyTree() {}

    PropertyTree(PropertyNode* root)
    {
        assert(root!=NULL);
        mRoot = *root;
        createChildren(mRoot,root);
    }

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("Root", mRoot, "");
    }

public:

    const PropertyNodeInfo& getRootNodeInfo() const {
        return mRoot;
    }

public:

    template <typename PropertyNodeType>
    PropertyNodeType* generatePropertyNodes(PropertyNodeType* root = NULL) const
    {
        // create property node, if no one was specified to be used
        if(root==NULL)
            root = new PropertyNodeType(mRoot);

        generateChildren<PropertyNodeType>(root, mRoot);
        return root;
    }

private:
    Node mRoot;
};


} // namespace

#endif