rousData.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_TELIF_TELIF_ROUSDATA_HPP
#define HLCC_TELIF_TELIF_ROUSDATA_HPP
 
#include <cstdint>
#include <queue>
#include <mutex>
#include <memory>
 
#include <Ccsinsif.hpp>
#include "Ccsinsifextref.hpp"
#include "Ccsinsifstroke.hpp"
#include "Ccsinsifao.hpp"
 
 
namespace hlcc::telif {
 
class DataContext;
class OldbInterface;
 
/*
 * Class that manages data used by Rous activity
 */
class RousData {
 public:
 
    enum RousManeuverState { ROUS_INIT,                 /* Initial State*/
                             ROUS_WAITING,              /* Waiting for the timer to finish*/
                             ROUS_MANEUVER_IN_PROGRESS, /* Processing ROUS Maneuver*/
                             ROUS_DISABLED };           /* Just Idling due to disablement*/
 
    explicit RousData(OldbInterface& oldb_interface,
                      std::shared_ptr<elt::mal::Mal> entity_factory);
 
    virtual ~RousData();
 
    RousData() = delete ;                           // Disable default constructor
    RousData(const RousData&) = delete;             // Disable Copy constructor
    RousData& operator=(const RousData&) = delete;  // Disable Assignment operator
 
    void SetRousState(const RousManeuverState &state);
 
    RousManeuverState GetRousState();
 
    void SetRousTimerSeconds(const std::uint16_t &time_s);
 
    std::uint16_t GetRousTimerSeconds();
 
    bool DecrementRousTimerSeconds();
 
    void SetRousDisableState(const bool &disabled);
 
    bool GetRousDisableState();
 
    void SetRousExecuteMessage();
 
    bool GetRousExecuteMessage();
 
    bool SetRousTimerUpdateMessage(const uint16_t &time_s);
 
    bool GetRousTimerUpdateMessage(uint16_t &time_s);
 
     void PublishRous();
 
     void SetPublishRousStatus(bool enable);
 
     void ActivityEntryAction();
 
     void ActivityExitAction();
 
 
 private:
    /* Pointer to Datacontext */
    OldbInterface& m_oldb_interface;
    /* Mal entity references */
    std::shared_ptr<elt::mal::Mal> m_entity_factory; // Mal used for pub-sub
    /* If Rous Data should be published */
    bool m_publish_data;
    /* Mutex to protect from race condition*/
    mutable std::mutex m_mutex;
    /* Current state of ROUS maneuver */
    RousManeuverState m_rous_state;
    /* Timer used to control ROUS execution */
    uint16_t m_rous_timer_s;
    /* Hold ROUS disable state */
    bool m_rous_disabled;
    /* Used to send rous_execute message to activity thread */
    std::queue<bool> m_rous_execute_q;
    /* Used to send rous_update_time message to activity thread */
    std::queue<std::uint64_t> m_rous_update_time_q;
    /* Data entity used to publish Rous data */
    std::shared_ptr<::ccsinsif::rous::Maneuver> m_rous_maneuver_data_entity;
};
 
} // namespace hlcc::telif
 
#endif  // HLCC_TELIF_TELIF_ROUSDATA_HPP