ConfigurationHelper.h

Go to the documentation of this file.

// Copyright 2020-2022 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
#ifndef LIMA_HELPERS_CONFIGURATION_HELPER_H
#define LIMA_HELPERS_CONFIGURATION_HELPER_H
 
#include "linguisticProcessing/LinguisticProcessingCommon.h"
 
#include <string>
#include <common/XMLConfigurationFiles/groupConfigurationStructure.h>
 
namespace Lima
{
namespace LinguisticProcessing
{
 
class LIMA_LP_HELPERS_EXPORT ConfigurationHelper
{
protected:
  ConfigurationHelper(const std::string& processUnitName, const std::string& loggingCategory)
    : m_processUnitName(processUnitName),
      m_loggingCategory(loggingCategory)
  {
  }
 
  enum Flags
  {
    REQUIRED = 0x1,
    NOT_EMPTY = 0x2,
    NOT_ZERO = 0x2
  };
 
  void getStringParameter(
      Common::XMLConfigurationFiles::GroupConfigurationStructure& unitConfiguration,
      const std::string& name,
      std::string& value,
      int flags = Flags::REQUIRED,
      std::string default_value = "");
 
  std::string getStringParameter(
      Common::XMLConfigurationFiles::GroupConfigurationStructure& unitConfiguration,
      const std::string& name,
      int flags = Flags::REQUIRED,
      std::string default_value = "");
 
  void getIntParameter(
      Common::XMLConfigurationFiles::GroupConfigurationStructure& unitConfiguration,
      const std::string& name,
      int& value,
      int flags = Flags::REQUIRED,
      int default_value = 0);
 
  int getIntParameter(
      Common::XMLConfigurationFiles::GroupConfigurationStructure& unitConfiguration,
      const std::string& name,
      int flags = Flags::REQUIRED,
      int default_value = 0);
 
  bool isInitLazy();
 
private:
  std::string m_processUnitName;
  std::string m_loggingCategory;
};
 
#define CONFIGURATIONHELPER_LOGGING_INIT(X) \
    namespace \
    { \
        inline std::string THIS_FILE_LOGGING_CATEGORY() \
        { \
            X; \
            return logger.zone().toStdString(); \
        } \
    }
 
}
}
#endif