Dict.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * Copyright (C) 2012-2016, High Performance Humanoid Technologies (H2T),
 * Karlsruhe Institute of Technology (KIT), all rights reserved.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @author     Fabian Peller-Konrad (fabian dot peller-konrad at kit dot edu)
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
// STD/STL
#include <map>
#include <memory>
#include <utility>
 
// Base class
#include "../detail/ContainerVariant.h"
 
// ArmarX
#include "../../../type/variant/any/AnyObject.h"
#include "../../../type/variant/container/Dict.h"
#include "../../../type/variant/container/Object.h"
 
namespace armarx::aron::data
{
    class Dict;
    typedef std::shared_ptr<Dict> DictPtr;
 
    class Dict : public detail::ContainerVariant<data::dto::Dict, Dict>
    {
    public:
        // constructors
        Dict(const Path& path = Path());
        Dict(const data::dto::DictPtr&, const Path& path = Path());
        Dict(const std::map<std::string, VariantPtr>&, const Path& path = Path());
 
        // operators
        using detail::ContainerVariant<data::dto::Dict, Dict>::operator==;
 
        bool operator==(const Dict&) const override;
        bool operator==(const DictPtr&) const override;
        VariantPtr operator[](const std::string&) const;
        Dict& operator=(const Dict&);
 
        static PointerType FromAronDictDTO(const data::dto::DictPtr& aron);
        static data::dto::DictPtr ToAronDictDTO(const PointerType& navigator);
 
        // public member functions
        data::dto::DictPtr toAronDictDTO() const;
        std::vector<std::string> getAllKeys() const;
        std::string getAllKeysAsString() const;
 
        void addElement(const std::string& key, const VariantPtr& = nullptr);
        void addElementCopy(const std::string& key, const VariantPtr& = nullptr);
        bool hasElement(const std::string&) const;
        void setElement(const std::string&, const VariantPtr& = nullptr);
        void setElementCopy(const std::string&, const VariantPtr& = nullptr);
        VariantPtr getElement(const std::string&) const;
        std::map<std::string, VariantPtr> getElements() const;
 
        void mergeAndReplace(const DictPtr& d);
        void mergeAndReplaceCopy(const DictPtr& d);
 
        VariantPtr at(const std::string&) const;
        void removeElement(const std::string& key);
        void clear();
 
        // virtual implementations
        using Base::clone;
        DictPtr clone(const Path& p) const override;
 
        std::string getShortName() const override;
        std::string getFullName() const override;
        std::vector<VariantPtr> getChildren() const override;
        size_t childrenSize() const override;
 
        type::VariantPtr recalculateType() const override;
        bool fullfillsType(const type::VariantPtr&) const override;
 
        VariantPtr navigateAbsolute(const Path& path) const override;
 
    private:
        // members
        std::map<std::string, VariantPtr> childrenNavigators;
    };
} // namespace armarx::aron::data
 
namespace armarx::aron
{
    template <typename... _Args>
    aron::data::DictPtr
    make_dict(_Args&&... args)
    {
        return std::make_shared<aron::data::Dict>(args...);
    }
} // namespace armarx::aron