dataContext.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_DATACONTEXT_HPP
#define HLCC_TRKSIM_DATACONTEXT_HPP
 
#include <mutex>
#include <memory>
 
#include <ptk/posastro.hpp>
#include <taiclock/taiClock.hpp>
#include <rad/dataContext.hpp>
#include "mal/utility/shared_vector.hpp"
#include "Ccsinsif.hpp"
#include "Ccsinsdetif.hpp"
#include <Msif.hpp>
 
#include "trksim/config.hpp"
#include "trksim/oldbInterface.hpp"
#include "trksim/monitoring.hpp"
#include "trksim/ambientData.hpp"
 
 
namespace hlcc::trksim {
 
 
struct AltAzOptional {
    std::optional<ptk::Radians> alt;
    std::optional<ptk::Radians> az;
};
 
class DataContext : public rad::DataContext {
 public:
    DataContext(std::shared_ptr<OldbInterface> oldb_interface = nullptr);
 
    virtual ~DataContext();
 
 
    void ReloadConfig() override;
 
    Config& GetConfig() override;
 
    const Config& GetConfigConst() const;
 
    void UpdateDb() override;
 
    OldbInterface& GetOldbInterface() override;
 
 
    void EnablePublishing(bool enabled);
 
    bool IsPublishingEnabled() const;
 
 
 
    std::shared_ptr<const ::msif::PresetArgs> GetPresetData() const;
 
    void SetPresetArgs(std::shared_ptr<const ::msif::PresetArgs> preset_args);
 
    ptk::EquatorialPosition GetTargetRaDec() const;
 
    ptk::EquatorialPosition GetTargetRaDecApparent() const;
 
    void SetTargetRaDecApparent(const ptk::EquatorialPosition& pos_apparent);
 
    bool GetTargetRaDecValidity() const;
 
    void SetTargetRaDecValidity(bool is_valid);
 
    void AddSkyOffset(ptk::Radians delta_ra, ptk::Radians delta_dec);
 
 
 
    std::optional<ptk::HorizonPositionEsoTimestamped> GetTargetAltAz(
            ::taiclock::TaiClock::time_point time_tai = ::taiclock::TaiClock::time_point{}) const;
 
    void SetTargetAltAz(
            const ptk::HorizonPositionEsoTimestamped& alt_az, ElapsedTimeStats& stats);
 
    void SetTargetAltAzToCurrent(ElapsedTimeStats& stats);
 
    ptk::HorizonPositionEsoTimestamped MergeTargetAltAz(const AltAzOptional& alt_az,
            ElapsedTimeStats& stats, ::taiclock::TaiClock::time_point time_tai = ptk::NextTimeEvent());
 
    bool GetTargetAltAzValidity() const;
 
    void SetTargetAltAzValidity(bool is_valid);
 
 
 
    ptk::HorizonPositionEsoTimestamped GetCurrentAltAz() const;
 
    void SetCurrentAltAz(const ptk::HorizonPositionEsoTimestamped& alt_az);
 
 
 
    enum class EstimatedState {
        UNDEFINED,
        STANDING_STILL,
        PRESETTING,
        TRACKING,
        MOVING
    };
 
    void SetEstimatedState(EstimatedState state);
 
    EstimatedState GetEstimatedState() const;
 
 
    ptk::PositionOnEarth GetSitePosition() const;
 
//    /**
//     * Writes the site info from configuration to the OLDB.
//     * It uses the defined periodicity for the writes. This means that it is not guaranteed
//     * that it will publish every time this method is called, but we should call the method
//     * frequently to ensure the period is constant.
//     *
//     * TODO: Rename this method to "PublishSiteInfo" because it does not modify any data
//     * in DataContext. It is not 'const' only because it uses flags "m_site_info_published"
//     * and "m_site_info_first_iteration", which could also be changed to become static
//     * local variables inside SetSiteInfo impl.
//     */
//    void SetSiteInfo(ElapsedTimeStats& stats);
 
 
 
    AmbientData& GetAmbientData();
 
 
    DataContext(const DataContext&) = delete;       
    DataContext& operator=(const DataContext&) = delete;  
 
 private:
    Config m_config;
 
    std::shared_ptr<OldbInterface> m_oldb_interface;
 
    bool            m_is_publishing_enabled;
 
    std::shared_ptr<const ::msif::PresetArgs> m_preset_args;
 
    ptk::EquatorialPosition m_ra_dec_target;
 
    ptk::EquatorialPosition m_ra_dec_target_apparent;
 
    bool m_ra_dec_target_is_valid;
 
    std::map<::taiclock::TaiClock::time_point, ptk::HorizonPositionEsoTimestamped> m_alt_az_target_map;
 
    bool m_alt_az_target_is_valid;
 
    ptk::HorizonPositionEsoTimestamped alt_az_current;
 
    EstimatedState estimated_state {EstimatedState::UNDEFINED};
 
    AmbientData m_ambient_data;
 
    bool m_site_info_published;
    bool m_site_info_first_iteration;
 
    mutable std::recursive_mutex m_mutex;
 
    std::atomic<bool> is_initialized;
};
 
 
constexpr const char* EstimatedStateToString(DataContext::EstimatedState state);
 
std::ostream& operator<<(std::ostream& os, DataContext::EstimatedState state);
 
 
}  // namespace hlcc::trksim
 
#endif  // HLCC_TRKSIM_DATACONTEXT_HPP