config.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2020-2025 European Southern Observatory (ESO)
//
// SPDX-License-Identifier: LGPL-3.0-only
 
#ifndef HLCC_TRKSIM_CONFIG_HPP
#define HLCC_TRKSIM_CONFIG_HPP
 
#include <string>
#include <config-ng/ciiConfigApi.hpp>
#include <rad/config.hpp>
#include "trksim/logger.hpp"
 
namespace hlcc::trksim {
/*
 * Struct representing a state variable description
 * with the state variable name and associated
 * state variable type script to be used.
 */
struct SvDescription {
    std::string sv_name;
    std::string sv_type;
};
 
}// namespace hlcc::trksim
 
 
namespace elt::configng {
 
// Implementation of converter between hlcc::trksim::SvDescription and CiiConfigInstanceNode hierarchy
// Decode method: Extract node values into hlcc::trksim::SvDescription
// Encode method: construct nodes from values of hlcc::trksim::SvDescription
template<>
struct CiiConfigValueConverter<hlcc::trksim::SvDescription, CiiConfigInstanceNode> {
  static bool Decode(const CiiConfigInstanceNode& node, hlcc::trksim::SvDescription &target) {
    if (node.GetKind() != CiiConfigNodeKind::MAP || node.GetDataTypeName() != "SvDescription") {
      std::cerr << "Conversion to SvDescription not possible" << std::endl;
      return false;
    }
    target.sv_name = node["sv_name"].As<std::string>();
    target.sv_type = node["sv_type"].As<std::string>();
    return true;
  }
 
  static bool Encode(CiiConfigInstanceNode &node, const hlcc::trksim::SvDescription &source) {
    if (node.GetKind() != elt::configng::CiiConfigNodeKind::MAP) {
      return false;
    }
    node.Set("sv_name", elt::configng::CiiConfigInstanceNode::From(source.sv_name));
    node.Set("sv_type", elt::configng::CiiConfigInstanceNode::From(source.sv_type));
    return true;
  }
};
 
} // namespace elt::configng
 
 
namespace hlcc::trksim {
 
class ConfigError : public std::runtime_error {
public:
    explicit ConfigError(const std::string& message)
        : std::runtime_error(message)
    {}
};
 
 
const char CONFIG_KEY_SEPARATOR_OLDB = '/';
// const char KEY_SEPARATOR_CFG = '.';
// const std::string CONFIG_ROOT_NODE = "app";
 
/*
 * Configuration OLDB Attributes.
 * Note that CII OLDB convert all keys to lowercase.
 *
 * The following definitions are handled in rad/cpp/app/src/include/rad/config.hpp
 * const std::string KEY_CONFIG = "cfg/";
 * const std::string KEY_CONFIG_VERSION = KEY_CONFIG + "version";
 * const std::string KEY_CONFIG_PROCNAME = KEY_CONFIG + "procname";
 * const std::string KEY_CONFIG_FILENAME = KEY_CONFIG + "filename";
 * const std::string KEY_CONFIG_LOG_LEVEL = KEY_CONFIG + "log_level";
 * const std::string KEY_CONFIG_LOG_PROPERTIES = KEY_CONFIG + "log_properties";
 * const std::string KEY_CONFIG_SM_SCXML = KEY_CONFIG + "sm_scxml";
 * const std::string KEY_CONFIG_SM_APPEND = KEY_CONFIG + "sm_scxml_append";
 * const std::string KEY_CONFIG_REQ_ENDPOINT = KEY_CONFIG + "req_endpoint";
 * const std::string KEY_CONFIG_OLDB_URI_PREFIX = KEY_CONFIG + "oldb_uri_prefix";
 * const std::string KEY_CONFIG_OLDB_CONN_TIMEOUT = KEY_CONFIG + "oldb_conn_timeout";
 * const std::string KEY_CONFIG_OLDB_ASYNC_PERIOD = KEY_CONFIG + "oldb_async_period";
 * const std::string KEY_CONFIG_TRS_HEALTH_ENABLED = KEY_CONFIG + "trs_health_enabled";
 */
const std::string KEY_CONFIG                            = rad::KEY_CONFIG;
const std::string KEY_CONFIG_PUB_DETERM_DEST            = KEY_CONFIG + "pub/determ/dest";
const std::string KEY_CONFIG_PUB_DETERM_NIC             = KEY_CONFIG + "pub/determ/nic";
const std::string KEY_CONFIG_PUB_DETERM_DEST2           = KEY_CONFIG + "pub/determ/dest2";
const std::string KEY_CONFIG_PUB_DETERM_DEST3           = KEY_CONFIG + "pub/determ/dest3";
const std::string KEY_CONFIG_PUB_DETERM_DEST4           = KEY_CONFIG + "pub/determ/dest4";
const std::string KEY_CONFIG_PUB_DETERM_DEST5           = KEY_CONFIG + "pub/determ/dest5";
const std::string KEY_CONFIG_PUB_DETERM_DEST6           = KEY_CONFIG + "pub/determ/dest6";
const std::string KEY_CONFIG_PUB_DDS_PROFILE            = KEY_CONFIG + "pub/dds/profile";
const std::string KEY_CONFIG_PUB_DDS_NIC                = KEY_CONFIG + "pub/dds/nic";
const std::string KEY_CONFIG_PUB_DDS_FILE               = KEY_CONFIG + "pub/dds/file";
const std::string KEY_CONFIG_PUB_DDS_DOMAIN_ID_HLCC     = KEY_CONFIG + "pub/dds/domain_id_hlcc";
const std::string KEY_CONFIG_PUB_DDS_DOMAIN_ID_CCS_INS  = KEY_CONFIG + "pub/dds/domain_id_ccs_ins";
const std::string KEY_CONFIG_PUB_DDS_DOMAIN_ID_GENERAL  = KEY_CONFIG + "pub/dds/domain_id_general";
const std::string KEY_CONFIG_PARAMS_MOV_MIN_DELTA       = KEY_CONFIG + "params/moving_min_delta";
const std::string KEY_CONFIG_PARAMS_TRACKING_ERROR      = KEY_CONFIG + "params/tracking_error";
const std::string KEY_CONFIG_PARAMS_ALT_SPEED_DEG_PER_S = KEY_CONFIG + "params/alt_speed_deg_per_s";
const std::string KEY_CONFIG_PARAMS_AZ_SPEED_DEG_PER_S  = KEY_CONFIG + "params/az_speed_deg_per_s";
const std::string KEY_CONFIG_ALTAZ_ALT_UPPER_LIMIT_OP   = KEY_CONFIG + "altaz/alt_upper_limit_op";
const std::string KEY_CONFIG_ALTAZ_ALT_LOWER_LIMIT_OP   = KEY_CONFIG + "altaz/alt_lower_limit_op";
const std::string KEY_CONFIG_ALTAZ_AZ_UPPER_LIMIT_OP    = KEY_CONFIG + "altaz/az_upper_limit_op";
const std::string KEY_CONFIG_ALTAZ_AZ_LOWER_LIMIT_OP    = KEY_CONFIG + "altaz/az_lower_limit_op";
const std::string KEY_CONFIG_ALTAZ_ALT_UPPER_LIMIT_FCT  = KEY_CONFIG + "altaz/alt_upper_limit_fct";
const std::string KEY_CONFIG_ALTAZ_ALT_LOWER_LIMIT_FCT  = KEY_CONFIG + "altaz/alt_lower_limit_fct";
const std::string KEY_CONFIG_ALTAZ_AZ_UPPER_LIMIT_FCT   = KEY_CONFIG + "altaz/az_upper_limit_fct";
const std::string KEY_CONFIG_ALTAZ_AZ_LOWER_LIMIT_FCT   = KEY_CONFIG + "altaz/az_lower_limit_fct";
const std::string KEY_CONFIG_SITE_INFO_ELEVATION        = KEY_CONFIG + "site/info/elevation";
const std::string KEY_CONFIG_SITE_INFO_LATITUDE         = KEY_CONFIG + "site/info/latitude";
const std::string KEY_CONFIG_SITE_INFO_LONGITUDE        = KEY_CONFIG + "site/info/longitude";
const std::string KEY_CONFIG_SITE_INFO_ID               = KEY_CONFIG + "site/info/id";
const std::string KEY_CONFIG_SV_LIST                    = KEY_CONFIG + "sv_list";
const std::string KEY_CONFIG_SV_SPECIFIC_CONFIG         = KEY_CONFIG + "sv_specific_config";
const std::string KEY_CONFIG_SIM_ACTIVITY_PERIOD_MS     = KEY_CONFIG + "sim_activity_period_ms";
 
const std::vector<std::string> OLDB_CFG_KEYS_STRING = {
    KEY_CONFIG_PUB_DETERM_DEST,
    KEY_CONFIG_PUB_DETERM_NIC,
    KEY_CONFIG_PUB_DETERM_DEST2,
    KEY_CONFIG_PUB_DETERM_DEST3,
    KEY_CONFIG_PUB_DETERM_DEST4,
    KEY_CONFIG_PUB_DETERM_DEST5,
    KEY_CONFIG_PUB_DETERM_DEST6,
    KEY_CONFIG_PUB_DDS_PROFILE,
    KEY_CONFIG_PUB_DDS_NIC,
    KEY_CONFIG_PUB_DDS_FILE,
    KEY_CONFIG_SITE_INFO_ID,
    KEY_CONFIG_SV_SPECIFIC_CONFIG
};
 
const std::vector<std::string> OLDB_CFG_KEYS_DOUBLE = {
    KEY_CONFIG_PARAMS_MOV_MIN_DELTA,
    KEY_CONFIG_PARAMS_TRACKING_ERROR,
    KEY_CONFIG_PARAMS_ALT_SPEED_DEG_PER_S,
    KEY_CONFIG_PARAMS_AZ_SPEED_DEG_PER_S,
    KEY_CONFIG_ALTAZ_ALT_UPPER_LIMIT_OP,
    KEY_CONFIG_ALTAZ_ALT_LOWER_LIMIT_OP,
    KEY_CONFIG_ALTAZ_AZ_UPPER_LIMIT_OP,
    KEY_CONFIG_ALTAZ_AZ_LOWER_LIMIT_OP,
    KEY_CONFIG_ALTAZ_ALT_UPPER_LIMIT_FCT,
    KEY_CONFIG_ALTAZ_ALT_LOWER_LIMIT_FCT,
    KEY_CONFIG_ALTAZ_AZ_UPPER_LIMIT_FCT,
    KEY_CONFIG_ALTAZ_AZ_LOWER_LIMIT_FCT,
    KEY_CONFIG_SITE_INFO_ELEVATION,
    KEY_CONFIG_SITE_INFO_LATITUDE,
    KEY_CONFIG_SITE_INFO_LONGITUDE,
};
 
const std::vector<std::string> OLDB_CFG_KEYS_UINT32 = {
    KEY_CONFIG_PUB_DDS_DOMAIN_ID_HLCC,
    KEY_CONFIG_PUB_DDS_DOMAIN_ID_CCS_INS,
    KEY_CONFIG_PUB_DDS_DOMAIN_ID_GENERAL,
    KEY_CONFIG_SIM_ACTIVITY_PERIOD_MS
};
 
 
const std::string CONFIG_DEFAULT_VERSION                    = std::string(VERSION);
const std::string CONFIG_DEFAULT_MODNAME                    = "trksim";
const std::string CONFIG_DEFAULT_PROCNAME                   = "trksim";
const std::string CONFIG_DEFAULT_FILENAME                   = "config/trksim/config.yaml";
const std::string CONFIG_DEFAULT_SCXML_FILENAME             = "config/trksim/sm.xml";
const std::string CONFIG_DEFAULT_SCXML_APPEND               = "";
const std::string CONFIG_DEFAULT_LOG_LEVEL                  = "INFO";
const std::string CONFIG_DEFAULT_LOG_PROPERTIES             = "config/trksim/log.properties";
const std::string CONFIG_DEFAULT_REQ_ENDPOINT               = "zpb.rr://127.0.0.1:11006/"; // the potentially unsafe zpb.rr://0.0.0.0:12081/ we use only in the yaml file.
const std::string CONFIG_DEFAULT_OLDB_URI_PREFIX            = "cii.oldb:///elt/tel/";
const uint32_t CONFIG_DEFAULT_OLDB_CONN_TIMEOUT             = 1;  // sec
const uint32_t CONFIG_DEFAULT_OLDB_ASYNC_PERIOD             = 0;  // ms; we currently do not use RAD async OLDB writes, but still configure all standard attributes.
const bool CONFIG_DEFAULT_TRS_HEALTH_ENABLED                = false;
 
const std::string CONFIG_DEFAULT_PUB_DETERM_DEST            = "239.128.7.1:10000"; // override telif:ccs:deterministic (CCsInsTopics.xml)
const std::string CONFIG_DEFAULT_PUB_DETERM_NIC             = "127.0.0.1"; // iface for mcast
const std::string CONFIG_DEFAULT_PUB_DETERM_DEST2           = "";
const std::string CONFIG_DEFAULT_PUB_DETERM_DEST3           = "";
const std::string CONFIG_DEFAULT_PUB_DETERM_DEST4           = "";
const std::string CONFIG_DEFAULT_PUB_DETERM_DEST5           = "";
const std::string CONFIG_DEFAULT_PUB_DETERM_DEST6           = "";
const std::string CONFIG_DEFAULT_PUB_DDS_PROFILE            = "";
const std::string CONFIG_DEFAULT_PUB_DDS_NIC                = "";
const std::string CONFIG_DEFAULT_PUB_DDS_FILE               = "";
const uint32_t CONFIG_DEFAULT_PUB_DDS_DOMAIN_ID_HLCC        = 3;
const uint32_t CONFIG_DEFAULT_PUB_DDS_DOMAIN_ID_CCS_INS     = 2;
const uint32_t CONFIG_DEFAULT_PUB_DDS_DOMAIN_ID_GENERAL     = 1;
const double CONFIG_DEFAULT_PARAMS_MOV_MIN_DELTA       = 0.003;   // arcsec/s - double
const double CONFIG_DEFAULT_PARAMS_TRACKING_ERROR      = 0.5;    // arcsec - double
const double CONFIG_DEFAULT_PARAMS_ALT_SPEED_DEG_PER_S = 5.0;    // degree - double
const double CONFIG_DEFAULT_PARAMS_AZ_SPEED_DEG_PER_S  = 5.0;    // degree - double
const double CONFIG_DEFAULT_ALTAZ_ALT_UPPER_LIMIT_OP   = 1.544616;  // radians - double
const double CONFIG_DEFAULT_ALTAZ_ALT_LOWER_LIMIT_OP   = 0.349066;  // radians - double
const double CONFIG_DEFAULT_ALTAZ_AZ_UPPER_LIMIT_OP    = 6.283185;  // radians - double
const double CONFIG_DEFAULT_ALTAZ_AZ_LOWER_LIMIT_OP    = -3.141593; // radians - double
const double CONFIG_DEFAULT_ALTAZ_ALT_UPPER_LIMIT_FCT  = 1.570796;  // radians - double
const double CONFIG_DEFAULT_ALTAZ_ALT_LOWER_LIMIT_FCT  = 0.0;       // radians - double
const double CONFIG_DEFAULT_ALTAZ_AZ_UPPER_LIMIT_FCT   = 6.283185;  // radians - double
const double CONFIG_DEFAULT_ALTAZ_AZ_LOWER_LIMIT_FCT   = -3.141593; // radians - double
const double CONFIG_DEFAULT_SITE_INFO_ELEVATION             = 3046;     // meters - double
const double CONFIG_DEFAULT_SITE_INFO_LATITUDE              = -0.429164; // radians - double
const double CONFIG_DEFAULT_SITE_INFO_LONGITUDE             = 1.225075;  // radians - double
const std::string CONFIG_DEFAULT_SITE_INFO_ID               = "ELT"; //
const std::vector<SvDescription> CONFIG_DEFAULT_SV_LIST     = {};
const std::string CONFIG_DEFAULT_SV_SPECIFIC_CONFIG         = "";
const uint32_t CONFIG_DEFAULT_SIM_ACTIVITY_PERIOD_MS     = 1000;
 
/*
 * Struct packing all configuration parameters
 */
struct ConfigPack {
    std::string modname;
    std::string procname;
    std::string filename;
    std::string sm_scxml;
    std::string sm_append;
    std::string log_level;
    std::string log_properties;
    std::string req_endpoint;
    std::string oldb_uri_prefix;
    int conn_timeout;
    int oldb_async_period;
    std::vector<SvDescription> sv_list;
    uint16_t sim_activity_period_ms;
    std::string sv_specific_config;
    std::string pub_dds_profile;
    std::string pub_dds_nic;
    std::string pub_dds_file;
    std::uint32_t pub_dds_domain_id_hlcc;
    std::uint32_t pub_dds_domain_id_ccs_ins;
    std::uint32_t pub_dds_domain_id_general;
};
 
class Config : public rad::Config {
 public:
    Config();
 
    virtual ~Config();
 
    ConfigPack GetConfigPack();
 
    Config(const Config&) = delete;              
    Config& operator=(const Config&) = delete;  
 
};
}  // namespace hlcc::trksim
 
#endif  // HLCC_TRKSIM_CONFIG_HPP