PTreeUtils.h

Go to the documentation of this file.

#ifndef PTREEUTILS_H_INCLUDED
#define PTREEUTILS_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include <boost/property_tree/ptree_fwd.hpp>

#include <list>
#include <set>
#include <string>
#include <utility>

namespace SimPT_Sim {
namespace Util {

class PTreeUtils
{
public:
        static void CopyNonExistingChildren(
                const boost::property_tree::ptree& src,
                boost::property_tree::ptree& dst,
                const std::set<std::string>& ignore = std::set<std::string>());

        static void CopyStructure(
                const boost::property_tree::ptree& src,
                boost::property_tree::ptree& dst,
                const std::string& fill_value,
                const std::set<std::string>& ignore = std::set<std::string>());

        static void RemoveNonExistingChildren(
                const boost::property_tree::ptree& src,
                boost::property_tree::ptree& dst,
                const std::set<std::string>& ignore = std::set<std::string>());

        static void FillPTree(boost::property_tree::ptree& pt1, const boost::property_tree::ptree& pt2);

        static std::list<std::pair<std::string, std::string>>
        Flatten(const boost::property_tree::ptree& pt, bool indexedArray = false, const std::string& path = "");

        static const boost::property_tree::ptree&
        GetIndexedChild(const boost::property_tree::ptree& pt, const std::string& path);

        static void PutIndexedChild(
                boost::property_tree::ptree& pt,
                const std::string& path,
                const boost::property_tree::ptree& child);
};

} // namespace
} // namespace

#endif // include-guard