AlgorithmBoilerplate.h

Go to the documentation of this file.

#define CONSTRUCT_IGUANA_ALGORITHM(ALGO_NAME, BASE_NAME) \
  ALGO_NAME(std::string_view name = "")                  \
      : BASE_NAME(name == "" ? GetClassName() : name)    \
  {                                                      \
    m_default_config_file = GetDefaultConfigFile();      \
    m_class_name          = GetClassName();              \
  }

#define DESTROY_IGUANA_ALGORITHM(ALGO_NAME) \
  ~ALGO_NAME() {}


#define IGUANA_ALGORITHM_PUBLIC_MEMBERS(ALGO_NAME, ALGO_FULL_NAME, BASE_NAME) \
  using BASE_NAME::Start;                                                     \
  using BASE_NAME::Run;                                                       \
  static algo_t Creator() { return std::make_unique<ALGO_NAME>(); }           \
  static std::string GetClassName() { return #ALGO_FULL_NAME; }               \
  static std::string GetDefaultConfigFile()                                   \
  {                                                                           \
    return ConfigFileReader::ConvertAlgoNameToConfigName(#ALGO_FULL_NAME);    \
  }

#define IGUANA_ALGORITHM_PRIVATE_MEMBERS \
  static bool s_registered;


#define DEFINE_IGUANA_SUBALGORITHM(ALGO_NAME, ALGO_FULL_NAME, BASE_NAME) \
private:                                                                 \
  IGUANA_ALGORITHM_PRIVATE_MEMBERS                                       \
public:                                                                  \
  CONSTRUCT_IGUANA_ALGORITHM(ALGO_NAME, BASE_NAME)                       \
  DESTROY_IGUANA_ALGORITHM(ALGO_NAME)                                    \
  IGUANA_ALGORITHM_PUBLIC_MEMBERS(ALGO_NAME, ALGO_FULL_NAME, BASE_NAME)

#define DEFINE_IGUANA_ALGORITHM(ALGO_NAME, ALGO_FULL_NAME) \
  DEFINE_IGUANA_SUBALGORITHM(ALGO_NAME, ALGO_FULL_NAME, Algorithm)

#define DEFINE_IGUANA_VALIDATOR(VDOR_NAME, VDOR_FULL_NAME) \
  DEFINE_IGUANA_SUBALGORITHM(VDOR_NAME, VDOR_FULL_NAME, Validator)


#define REGISTER_IGUANA_ALGORITHM(ALGO_NAME, ...) \
  bool ALGO_NAME::s_registered = AlgorithmFactory::Register(ALGO_NAME::GetClassName(), ALGO_NAME::Creator, {__VA_ARGS__});

#define REGISTER_IGUANA_VALIDATOR(VDOR_NAME) \
  REGISTER_IGUANA_ALGORITHM(VDOR_NAME)


#define DEPRECATE_IGUANA_ALGORITHM(CODE)         \
  void Start(hipo::banklist& banks) override     \
  {                                              \
    CODE                                         \
  }                                              \
  bool Run(hipo::banklist& banks) const override \
  {                                              \
    CODE return false;                           \
  }                                              \
  void Stop() override                           \
  {                                              \
    CODE                                         \
  }