fitsController.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_ocm_libdaq
 * @copyright 2021 ESO - European Southern Observatory
 *
 * @brief Contains declaration for for FitsController
 */
#ifndef OCF_DAQ_FITS_CONTROLLER_HPP_
#define OCF_DAQ_FITS_CONTROLLER_HPP_
#include "config.hpp"
 
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <variant>
 
#include <boost/thread/future.hpp>
#include <daq/fits/cfitsio.hpp>
#include <daq/fits/keyword.hpp>
#include <log4cplus/logger.h>
 
#include "daqProperties.hpp"
#include "error.hpp"
#include "eventLog.hpp"
#include "state.hpp"
#include "status.hpp"
 
namespace daq {
 
class FitsController;
 
/**
 * Print status information to provided ostream.
 *
 * @ingroup daq_ocm_libdaq
 */
std::ostream& operator<<(std::ostream& os, FitsController const& ctl);
 
/**
 * Create FITS file containing keywords from OCM for the Data Acquisition.
 *
 * Responsibilities:
 * - Create FITS file for persistance.
 * - Accept keywords and keyword changes from user and store them in FITS file.
 *
 * @note It is not planned to be responsible for any crash recovery storage.
 * List of keywords are temporarily stored in daq::Status/daq::ObservableStatus.
 
 * Design notes:
 * - Async interface was not deemed necessary.
 *
 * Pending interface:
 *  - AddComment()
 *
 * @ingroup daq_ocm_libdaq
 */
class FitsController {
public:
    virtual ~FitsController() = default;
    /** @name Modifiers
     * @{
     */
    /**
     * Creates FITS file and pupulates it with initial list of keywords.
     *
     * @pre `GetState() == State::NotStarted`.
     * @throws fits::CfitsioError on errors with cfitsio.
     * @throws std::runtime_error on error.
     */
    virtual void Start() = 0;
 
    /**
     * Finalizes the FITS file.
     *
     * If policy ErrorPolicy::Strict the function will throw if there was any error in creating the
     * FITS file. If policy is ErrorPolicy::Tolerant exception will only be thrown for fatal errors,
     * not if FITS file failed to be created.
     *
     * @param policy Controls the error policy.
     *
     * @return Created and closed FITS file if successful.
     * @return std::nullopt if file could not be created and policy is ErrorPolicy;:Tolerant.
     *
     * @throws std::runtime_error if `GetState() != State::Acquiring`.
     * @throws daq::fits::CfitsioError if no FITS file could be created and policy ==
     * ErrorPolicy::Strict.
     */
    virtual std::optional<DpPart> Stop(ErrorPolicy policy) = 0;
 
    /**
     * Aborts and deletes FITS file.
     * @pre `GetState() == State::Acquiring`.
     */
    virtual void Abort(ErrorPolicy policy) = 0;
 
    /**
     * Updates with provided keywords.
     *
     * @param keywords Keywords to add or replace.
     " @throws std::runtime_error if `GetState() == State::Stopped || GetState() == State::Aborted`.
     */
    virtual void UpdateKeywords(std::vector<fits::KeywordVariant> const& keywords) = 0;
 
    /**
     * Add comment.
     *
     * @pre `GetState() != State::Stopped && GetState() != State::Aborted`.
     *
     * @param comment Comment to add to FITS file.
     " @throws std::runtime_error if `GetState() == State::Stopped || GetState() == State::Aborted`.
     */
    virtual void AddComment(std::string comment) = 0;
 
    /** @} */
 
    /** @name Accessors
     * @{
     */
    virtual std::string const& GetId() const DAQ_NOEXCEPT = 0;
 
    /**
     * Query FITS file path.
     *
     * @return FITS file name.
     */
    virtual std::optional<DpPart> GetResult() const DAQ_NOEXCEPT = 0;
 
    /**
     * Query state.
     *
     * @return state.
     */
    virtual State GetState() const DAQ_NOEXCEPT = 0;
    /** @} */
};
 
class FitsControllerImpl final : public FitsController {
public:
    FitsControllerImpl(
        DaqProperties const& properties,
        std::shared_ptr<ObservableEventLog> event_log,
        std::function<fits::UniqueFitsFile(char const*)> fits_create = &fits::CreateEmpty);
    void Start() override;
    std::optional<DpPart> Stop(ErrorPolicy policy) override;
    void Abort(ErrorPolicy policy) override;
    void UpdateKeywords(std::vector<fits::KeywordVariant>const& ) override;
    void AddComment(std::string comment) override;
 
    std::string const& GetId() const DAQ_NOEXCEPT override;
    std::optional<DpPart> GetResult() const DAQ_NOEXCEPT override;
    State GetState() const DAQ_NOEXCEPT override;
 
    fitsfile* GetFitsfile() const noexcept {
        return m_file.get();
    }
 
private:
    struct NotStarted {};
    struct Acquiring {};
    struct Stopped {};
    struct Aborted {};
    using StateVariant = std::variant<NotStarted, Acquiring, Stopped, Aborted>;
 
    /**
     * Write keywords from m_keywords and m_comments to already opened m_file,
     * formatting them according to dictionary (TODO)
     */
    void WriteFitsfile();
 
    std::string m_id;
    std::string m_out_path;
    std::shared_ptr<ObservableEventLog> m_event_log;
    std::function<fits::UniqueFitsFile(char const*)> m_fits_create;
 
    std::string m_hostname;
    /** Internal state */
    StateVariant m_state;
    /** Internal storage of keywords for easy modification until written to file */
    std::vector<fits::KeywordVariant> m_keywords;
    std::vector<std::string> m_comments;
 
    /**
     * FITS absolute file path. Is empty until created in StartAsync().
     */
    std::string m_file_path;
    fits::UniqueFitsFile m_file;
    DpPart m_result;
    log4cplus::Logger m_logger;
};
 
}  // namespace daq
 
#endif  // #ifndef OCF_DAQ_FITS_CONTROLLER_HPP_