HomegearDeviceTranslation.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * libhomegear-base 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef HOMEGEARDEVICETRANSLATION_H_
#define HOMEGEARDEVICETRANSLATION_H_

#include <string>
#include <memory>
#include <unordered_map>

namespace rapidxml
{
class xml_node;
}

using namespace rapidxml;

namespace BaseLib
{

class SharedObjects;

namespace DeviceDescription
{

class HomegearDeviceTranslation;

typedef std::shared_ptr<HomegearDeviceTranslation> PHomegearDeviceTranslation;

class HomegearDeviceTranslation
{
public:
    struct ParameterTranslation
    {
        std::string label;
        std::string description;
    };

    HomegearDeviceTranslation(BaseLib::SharedObjects* baseLib, std::string xmlFilename);
    virtual ~HomegearDeviceTranslation();

    //{{{ XML entries
    std::string lang;
    std::unordered_map<std::string, std::string> typeDescriptions;
    std::unordered_map<std::string, std::string> typeLongDescriptions;
    std::unordered_map<std::string, std::unordered_map<std::string, ParameterTranslation>> configParameters;
    std::unordered_map<std::string, std::unordered_map<std::string, ParameterTranslation>> linkParameters;
    std::unordered_map<std::string, std::unordered_map<std::string, ParameterTranslation>> variables;
    //}}}

    bool loaded() { return _loaded; }
protected:
    BaseLib::SharedObjects* _bl = nullptr;
    bool _loaded = false;

    void load(std::string xmlFilename);
    void parseXML(xml_node* node);
};
}
}

#endif