add mcc directory

mcc/mcc_ccte_iers.h

@@ -0,0 +1,491 @@
+#pragma once
+
+/*  MOUNT CONTROL COMPONENTS LIBRARY  */
+
+
+/* Classes to represent IERS bulletins
+ *
+ * BULLETIN A: https://datacenter.iers.org/data/latestVersion/bulletinA.txt
+ * leapseconds: https://hpiers.obspm.fr/iers/bul/bulc/Leap_Second.dat
+ *
+ */
+
+#include <chrono>
+#include <fstream>
+
+#include "mcc_ccte_iers_default.h"
+#include "mcc_traits.h"
+#include "mcc_utils.h"
+
+namespace mcc::ccte::iers
+{
+
+class MccLeapSeconds final
+{
+public:
+    typedef std::chrono::system_clock::time_point time_point_t;
+    typedef std::chrono::duration<double> real_secs_t;  // seconds duration in double
+
+    MccLeapSeconds()
+    {
+        // create default values
+        std::istringstream ist(defaults::MCC_DEFAULT_LEAP_SECONDS_FILE);
+
+        load(ist);
+    }
+
+    ~MccLeapSeconds() = default;
+
+
+    time_point_t expireDate() const
+    {
+        return _expireDate;
+    }
+
+    auto expireMJD() const
+    {
+        return _expireMJD;
+    }
+
+    // load from stream
+    bool load(std::derived_from<std::basic_istream<char>> auto& stream, char comment_sym = '#')
+    {
+        std::istringstream is;
+        double mjd;
+        unsigned day, month;
+        int year;
+        double tai_utc;
+
+        decltype(_expireDate) edate;
+        std::vector<leapsecond_db_elem_t> db;
+
+        for (std::string line; std::getline(stream, line);) {
+            auto sv = utils::trimSpaces(line, utils::TrimType::TRIM_LEFT);
+
+            if (sv.size()) {
+                if (sv[0] == comment_sym) {  // comment string
+                    if (std::regex_match(line, expr_date_rx)) {
+                        auto pos = line.find("on");
+                        sv = utils::trimSpaces(std::string_view{line.begin() + pos + 2, line.end()},
+                                               utils::TrimType::TRIM_LEFT);
+                        is.str({sv.begin(), sv.end()});
+                        is >> std::chrono::parse("%d %B %Y", edate);
+                        is.clear();
+                    }
+                    continue;
+                }
+            } else {
+                continue;
+            }
+
+            if (std::regex_match(line, data_rx)) {
+                is.str(line);
+                is >> mjd >> day >> month >> year >> tai_utc;
+                db.emplace_back(mjd, std::chrono::year_month_day{std::chrono::year{year} / month / day}, tai_utc);
+                // db.emplace_back(mjd,
+                //                 std::chrono::year_month_day{std::chrono::year{year}, std::chrono::month{month},
+                //                                             std::chrono::day{day}},
+                //                 tai_utc);
+                is.clear();
+
+                continue;
+            }
+        }
+
+        if (db.empty()) {  // keep previous data
+            return false;
+        }
+
+        _expireDate = std::move(edate);
+
+        // compute expire Julian Day
+        using namespace std::literals::chrono_literals;
+
+        std::chrono::year_month_day ymd{std::chrono::floor<std::chrono::days>(_expireDate)};
+
+        static constexpr std::chrono::year MIN_YEAR = -4799y;
+
+        if (ymd.year() < MIN_YEAR) {
+            return -1;
+        }
+        if (!ymd.month().ok()) {
+            return -2;
+        }
+
+        int64_t im = (unsigned)ymd.month();
+        int64_t id = (unsigned)ymd.day();
+        int64_t iy = (int)ymd.year();
+
+        int64_t my = (im - 14LL) / 12LL;
+        int64_t iypmy = iy + my;
+
+        // integer part of result MJD
+        int64_t mjd_int = (1461LL * (iypmy + 4800LL)) / 4LL + (367LL * (im - 2LL - 12LL * my)) / 12LL -
+                          (3LL * ((iypmy + 4900LL) / 100LL)) / 4LL + id - 2432076LL;
+
+        _expireMJD = static_cast<double>(mjd_int);
+
+
+        _db = std::move(db);
+
+        return true;
+    }
+
+
+    bool load(traits::mcc_input_char_range auto const& filename, char comment_sym = '#')
+    {
+        std::ifstream fst(filename);
+
+        bool ok = fst.is_open();
+        if (!ok) {
+            return false;
+        }
+
+        ok = load(fst, comment_sym);
+
+        fst.close();
+
+        return ok;
+    }
+
+
+    // std::optional<double> operator[](const time_point_t& tp) const
+    std::optional<real_secs_t> operator[](const time_point_t& tp) const
+    {
+        if (tp > _expireDate) {  // ???????!!!!!!!!!!!
+            return std::nullopt;
+            // return _db.back().tai_utc;
+        }
+
+        std::chrono::year_month_day ymd{std::chrono::floor<std::chrono::days>(tp)};
+
+        for (auto const& el : _db | std::views::reverse) {
+            if (ymd >= el.ymd) {
+                // return el.tai_utc;
+                return real_secs_t{el.tai_utc};
+            }
+        }
+
+        return std::nullopt;
+    }
+
+    // std::optional<double> operator[](const double& mjd) const
+    std::optional<real_secs_t> operator[](const double& mjd) const
+    {
+        double e_mjd;
+
+        if (mjd > _expireMJD) {  // ???????!!!!!!!!!!!
+            return std::nullopt;
+            // return _db.back().tai_utc;
+        }
+
+        for (auto const& el : _db | std::views::reverse) {
+            if (mjd >= el.mjd) {
+                return real_secs_t{el.tai_utc};
+            }
+        }
+
+        return std::nullopt;
+    }
+
+
+    void dump(std::derived_from<std::basic_ostream<char>> auto& stream) const
+    {
+        stream << std::format("Leap seconds database expire date: {}", _expireDate) << '\n';
+        for (auto const& el : _db) {
+            stream << std::format("{} {} {}", el.mjd, el.ymd, el.tai_utc) << '\n';
+        }
+    }
+
+
+private:
+    inline static const std::regex expr_date_rx{
+        "^ *# *File +expires +on +[0-8]{1,2} "
+        "+(January|February|March|April|May|June|July|August|September|October|November|December) +[0-9]{4} *$"};
+
+    inline static const std::regex data_rx{"^ *[0-9]{5,}(\\.?[0-9]+) +[0-9]{1,2} +[0-9]{1,2} +[0-9]{4} +[0-9]{1,} *$"};
+
+    time_point_t _expireDate{};
+    double _expireMJD{};
+
+    struct leapsecond_db_elem_t {
+        double mjd;
+        std::chrono::year_month_day ymd;
+        double tai_utc;  // TAI-UTC in seconds
+    };
+
+    std::vector<leapsecond_db_elem_t> _db{};
+};
+
+
+
+class MccIersBulletinA final
+{
+public:
+    typedef std::chrono::system_clock::time_point time_point_t;
+    typedef std::chrono::duration<double> real_secs_t;  // seconds duration in double
+
+    struct pole_pos_t {
+        double x, y;
+    };
+
+    struct date_range_t {
+        std::chrono::year_month_day begin;
+        std::chrono::year_month_day end;
+    };
+
+    struct date_range_mjd_t {
+        double begin;
+        double end;
+    };
+
+    MccIersBulletinA()
+    {
+        // create pre-defined (default-state) database
+        std::istringstream ist(defaults::MCC_DEFAULT_IERS_BULLETIN_A_FILE);
+
+        load(ist);
+    }
+
+    ~MccIersBulletinA() = default;
+
+    std::chrono::system_clock::time_point bulletinDate() const
+    {
+        return _date;
+    }
+
+
+    date_range_t dateRange() const
+    {
+        return {_db.front().ymd, _db.back().ymd};
+    }
+
+    date_range_mjd_t dateRangeMJD() const
+    {
+        return {_db.front().mjd, _db.back().mjd};
+    }
+
+
+    // double TT_TAI() const
+    real_secs_t TT_TAI() const
+    {
+        return real_secs_t{_tt_tai};
+    }
+
+    // DUT1 = UT1 - UTC
+    // std::optional<double> DUT1(const time_point_t& tp) const
+    std::optional<real_secs_t> DUT1(const time_point_t& tp) const
+    {
+        // use of the closest date
+        std::chrono::year_month_day ymd{std::chrono::round<std::chrono::days>(tp)};
+
+        if (ymd < _db.front().ymd) {
+            return std::nullopt;
+        }
+
+        if (ymd > _db.back().ymd) {
+            return std::nullopt;
+        }
+
+        for (auto const& el : _db) {
+            if (ymd <= el.ymd) {
+                return real_secs_t{el.dut1};
+            }
+        }
+
+        return std::nullopt;
+    }
+
+    // std::optional<double> DUT1(double mjd) const
+    std::optional<real_secs_t> DUT1(double mjd) const
+    {
+        mjd = std::round(mjd);  // round to closest integer MJD
+
+        if (mjd < _db.front().mjd) {
+            return std::nullopt;
+        }
+
+        if (mjd > _db.back().mjd) {
+            return std::nullopt;
+        }
+
+        for (auto const& el : _db) {
+            if (mjd <= el.mjd) {
+                return real_secs_t{el.dut1};
+            }
+        }
+
+        return std::nullopt;
+    }
+
+    std::optional<pole_pos_t> polarCoords(const time_point_t& tp) const
+    {
+        std::chrono::year_month_day ymd{std::chrono::round<std::chrono::days>(tp)};
+
+        if (ymd < _db.front().ymd) {
+            return std::nullopt;
+        }
+
+        if (ymd > _db.back().ymd) {
+            return std::nullopt;
+        }
+
+        for (auto const& el : _db) {
+            if (ymd <= el.ymd) {
+                return pole_pos_t{el.x, el.y};
+            }
+        }
+
+        return std::nullopt;
+    }
+
+    std::optional<pole_pos_t> polarCoords(double mjd) const
+    {
+        mjd = std::round(mjd);  // round to closest integer MJD
+
+        if (mjd < _db.front().mjd) {
+            return std::nullopt;
+        }
+
+        if (mjd > _db.back().mjd) {
+            return std::nullopt;
+        }
+
+        for (auto const& el : _db) {
+            if (mjd <= el.mjd) {
+                return pole_pos_t{el.x, el.y};
+            }
+        }
+
+        return std::nullopt;
+    }
+
+    bool load(std::derived_from<std::basic_istream<char>> auto& stream, char comment_sym = '*')
+    {
+        std::vector<earth_orient_db_elem_t> db;
+        enum { TAB_STATE_SEEK, TAB_STATE_START };
+        int tab_state = TAB_STATE_SEEK;
+
+        int year;
+        unsigned month, day;
+        double mjd, x, y, dut1;
+        std::istringstream is;
+        decltype(_date) bdate;
+        double tt_tai;
+
+        for (std::string line; std::getline(stream, line);) {
+            if (line.empty()) {
+                continue;
+            }
+
+            auto sv = utils::trimSpaces(line, utils::TrimType::TRIM_LEFT);
+
+            if (sv.size()) {
+                if (sv[0] == comment_sym) {  // comment string
+                    continue;
+                }
+
+                if (tab_state == TAB_STATE_START) {
+                    if (std::regex_match(sv.begin(), sv.end(), bull_tab_vals_rx)) {
+                        // is.str({sv.begin(), sv.end()});
+                        is.str(line);
+                        is >> year >> month >> day >> mjd >> x >> y >> dut1;
+                        db.emplace_back(mjd, std::chrono::year_month_day{std::chrono::year{year} / month / day}, x, y,
+                                        dut1);
+                        is.clear();
+                    } else {  // end of the table - just stop parsing
+                        break;
+                    }
+
+                    continue;
+                }
+
+                if (std::regex_match(sv.begin(), sv.end(), bull_date_rx)) {
+                    is.str({sv.begin(), sv.end()});
+                    is >> std::chrono::parse("%d %B %Y", bdate);
+                    continue;
+                }
+
+                if (std::regex_match(sv.begin(), sv.end(), bull_tt_tai_rx)) {
+                    is.str({sv.begin(), sv.end()});
+                    std::string dummy;
+                    is >> dummy >> dummy >> dummy >> dummy >> tt_tai;
+                    continue;
+                }
+
+                if (std::regex_match(sv.begin(), sv.end(), bull_tab_title_rx)) {
+                    tab_state = TAB_STATE_START;
+                    continue;
+                }
+
+            } else {  // empty string (only spaces)
+                continue;
+            }
+        }
+
+        if (db.empty()) {
+            return false;
+        }
+
+        _date = std::move(bdate);
+        _tt_tai = tt_tai;
+        _db = std::move(db);
+
+        return true;
+    }
+
+    bool load(traits::mcc_input_char_range auto const& filename, char comment_sym = '*')
+    {
+        std::ifstream fst(filename);
+
+        bool ok = fst.is_open();
+        if (!ok) {
+            return false;
+        }
+
+        ok = load(fst, comment_sym);
+
+        fst.close();
+
+        return ok;
+    }
+
+
+    void dump(std::derived_from<std::basic_ostream<char>> auto& stream) const
+    {
+        stream << std::format("Bulletin A issue date: {}", _date) << '\n';
+        stream << std::format("TT-TAI: {}", _tt_tai) << '\n';
+        for (auto const& el : _db) {
+            stream << std::format("{} {} {:6.4f} {:6.4f} {:7.5f}", el.mjd, el.ymd, el.x, el.y, el.dut1) << '\n';
+        }
+    }
+
+private:
+    inline static const std::regex bull_date_rx{
+        "^ *[0-9]{1,2} +(January|February|March|April|May|June|July|August|September|October|November|December) "
+        "+[0-9]{4,} +Vol\\. +[XMLCDVI]+ +No\\. +[0-9]+ *$"};
+
+    inline static const std::regex bull_tt_tai_rx{"^ *TT += +TAI +\\+ +[0-9]+\\.[0-9]+ +seconds *$"};
+
+    inline static const std::regex bull_tab_title_rx{"^ *MJD +x\\(arcsec\\) +y\\(arcsec\\) +UT1-UTC\\(sec\\) *$"};
+
+    inline static const std::regex bull_tab_vals_rx{
+        "^ *[0-9]{4,} +[0-9]{1,2} +[0-9]{1,2} +[0-9]{5,} +[0-9]+\\.[0-9]+ +[0-9]+\\.[0-9]+ +[0-9]+\\.[0-9]+ *$"};
+
+
+    time_point_t _date;
+    double _tt_tai;
+
+    struct earth_orient_db_elem_t {
+        double mjd;
+        std::chrono::year_month_day ymd;
+        double x, y;  // Polar coordinates in arcsecs
+        double dut1;  // UT1-UTC in seconds
+    };
+
+    std::vector<earth_orient_db_elem_t> _db;
+};
+
+
+
+}  // namespace mcc::ccte::iers