daqContext.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_common_libdaq
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Contains declaration of `daq::Context`.
 */
#ifndef OCM_DAQ_DAQ_CONTEXT_HPP_
#define OCM_DAQ_DAQ_CONTEXT_HPP_
#include <daq/config.hpp>
 
#include <chrono>
#include <string>
 
#include <daq/dpPart.hpp>
#include <daq/fits/keyword.hpp>
#include <daq/json/startDaqV2.hpp>
 
namespace daq {
 
/**
 * Structure carrying context needed to start a Data Acquisition and construct a Data Product
 * Specification needed to execute merge.
 *
 * This information can be serialized and deserialized to facilitate persitant storage.
 *
 * In practice this means it must contain:
 * - Data sources
 * - Results from acquisition phase (files and keywords)
 * - Per-DAQ User options
 *
 * When creating a Data Product Specification consider:
 *
 * - `results` contain files and keywords from data sources and `keywords` the user-provided
 *   keywords via request/reply interface (StartDaq/UpdateKeywords). Both must be considered
 *   when creating the final Data Product Specification.
 * - `results` is not sorted according.
 *
 * @seealso daq::Status
 * @ingroup daq_common_libdaq
 */
struct DaqContext {
    struct Source {
        std::string name;
        std::string rr_uri;
    };
    DaqContext() = default;
    DaqContext(DaqContext const&) = default;
    DaqContext(DaqContext&&) = default;
    DaqContext& operator=(DaqContext&&) = default;
    DaqContext& operator=(DaqContext const&) = default;
 
    /**
     * DAQ identfier, possibly provided by user.
     *
     * If user does not provide an id for the DAQ when starting it is identical to `file_id`.
     */
    std::string id;
 
    /**
     * Data Product @a FileId as specified by OLAS ICD.
     */
    std::string file_id;
 
    /**
     * User defined process name.
     */
    std::string process_name;
 
    /**
     * Data product file name prefix
     */
    std::string dp_name_prefix;
    std::vector<Source> prim_sources;
    std::vector<Source> meta_sources;
 
    /**
     * Keyword list provided by OCM to Data Product.
     *
     * Keywords comes from:
     * - StartDaq() request
     * - UpdateKeywords() request
     * - OCM internal keywords.
     */
    std::vector<daq::fits::KeywordVariant> keywords;
 
    /**
     * Interval (and thus duration) of the requests sent to primary sources
     * to await end of recording.
     * Default is 10 seconds.
     */
    std::chrono::milliseconds await_interval = std::chrono::seconds(10);
 
    /**
     * Results from Data Acquisition (FITS files and keywords).
     *
     * @note The sources are sorted by order of creation, not order they should appear in
     * DpSpec!
     */
    DpParts results;
 
    /**
     * Time when DAQ was created. This should correspond to the exact time used for generating the
     * file_id.
     */
    std::chrono::system_clock::time_point creation_time;
 
    /**
     * Optional specification, if DAQ was started using StartDaqV2.
     *
     * Some fields are duplicated or provided in different format, like dp_name_prefix, prim_sources
     * and meta_sources.
     */
    std::optional<json::StartDaqV2Spec> specification;
};
 
bool operator==(DaqContext const& lhs, DaqContext const& rhs) noexcept;
bool operator==(DaqContext::Source const& lhs, DaqContext::Source const& rhs) noexcept;
 
/**
 * Updates (adds or replaces) primary HDU keywords.
 *
 * @param out Keywords to update to.
 * @param in Keywords to format and update from.
 * @param fmt Keyword formatter.
 *
 * @throws fits::UnknownKeyword if keyword is unknown.
 * @throws std::invalid_argument if an invalid keyword is encountered.
 */
void UpdateKeywords(fits::KeywordVector& out,
                    fits::KeywordVector const& in,
                    fits::KeywordFormatter const& fmt);
/**
 * Updates (adds or replaces) primary HDU keywords.
 *
 * @param ctx Context to modify
 * @param keywords Keywords to format and update from.
 * @param fmt Keyword formatter.
 *
 * @throws fits::UnknownKeyword if keyword is unknown.
 * @throws std::invalid_argument if an invalid keyword is encountered.
 */
void UpdateKeywords(DaqContext& ctx,
                    fits::KeywordVector const& keywords,
                    fits::KeywordFormatter const& fmt);
 
/*
 * Records that a file has been produced for this data acquisition.
 *
 * @param ctx Context to modify.
 * @param files Files to add/record.
 *
 * @post Connected observers have been signalled.
 */
void AddDpParts(DaqContext& ctx, std::vector<DpPart> const& files);
 
}  // namespace daq
#endif  // #ifndef OCM_DAQ_DAQ_CONTEXT_HPP_