defines.hpp

Go to the documentation of this file.

 
#ifndef IFW_DIT_DID_DEFINES_HPP_
#define IFW_DIT_DID_DEFINES_HPP_
 
#include <string>
 
#include <log4cplus/logger.h>
#include <log4cplus/version.h>
#include <log4cplus/configurator.h>
 
#include <ciiLogManager.hpp>
 
#include <config-ng/ciiConfigApi.hpp>
 
#include <rad/logger.hpp>
#include <rad/exceptions.hpp>
 
namespace ifw::core::dit::did {
 
    log4cplus::Logger& Logger();

    enum class HdrField {
        NAME = 1,
        SCOPE = 2,
        DESCRIPTION = 4,
 
        ALL = (NAME | SCOPE | DESCRIPTION)
    };
 
    const std::string DID_SCHEMA_INCLUDE = "!cfg.include schema/ifw/core/dit/did/did.schema.yaml";
 
    const std::string HDR_TAG = "header";
 
    // Dictionary Header Fields.
    const std::string HDR_FIELD_NAME = "name";
    const std::string HDR_FIELD_SCOPE = "scope";
    const std::string HDR_FIELD_DESCRIPTION = "description";
 
    const std::map<HdrField, std::string> HDR_FIELDS_NB_MAP = {
        {HdrField::NAME, HDR_FIELD_NAME},
        {HdrField::SCOPE, HDR_FIELD_SCOPE},
        {HdrField::DESCRIPTION, HDR_FIELD_DESCRIPTION}};
 
    const std::map<std::string, HdrField> HDR_FIELDS_NAME_MAP{
        {HDR_FIELD_NAME, HdrField::NAME},
        {HDR_FIELD_SCOPE, HdrField::SCOPE},
        {HDR_FIELD_DESCRIPTION, HdrField::DESCRIPTION}};

    enum class DataType {
        BOOL = 1,
        DOUBLE = 2,
        INTEGER = 4,
        STRING = 8,
 
        ALL = (BOOL | DOUBLE | INTEGER | STRING)
    };
 
    // CII Cfg textual names for the record data types.
    const std::string REC_TYPE_BOOL = "DidBoolKey";
    const std::string REC_TYPE_DOUBLE = "DidDblKey";
    const std::string REC_TYPE_INTEGER = "DidIntKey";
    const std::string REC_TYPE_STRING = "DidStrKey";

    DataType DataTypeToNum(const std::string& type);

    std::string DataTypeToStr(const DataType type);

    enum class RecField {
        FORMAT = 1,
        UNIT = 2,
        COMMENT = 4,
        DESCRIPTION = 8,
        TYPE = 128,
 
        ALL = (FORMAT | UNIT | COMMENT | DESCRIPTION | TYPE)
    };
 
    // Dictionary Record Fields.
    const std::string REC_FIELD_FORMAT = "format";
    const std::string REC_FIELD_UNIT = "unit";
    const std::string REC_FIELD_COMMENT = "comment";
    const std::string REC_FIELD_DESCRIPTION = "description";
    const std::string REC_FIELD_TYPE = "type";

    std::string RecFieldToStr(const RecField field);

    RecField RecFieldToNum(const std::string& field);
 
}  // namespace ifw::core::dit::did
 
#endif  // !IFW_DIT_DID_DEFINES_HPP_