daqProperties.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_ocm_libdaq
 * @copyright 2021 ESO - European Southern Observatory
 *
 * @brief Contains declaration of `daq::Properties`.
 */
#ifndef OCM_DAQ_DAQ_PROPERTIES_HPP_
#define OCM_DAQ_DAQ_PROPERTIES_HPP_
 
#include <chrono>
#include <string>
 
#include "source.hpp"
 
#include <daq/fits/keyword.hpp>
 
namespace daq {
 
    /**
     * Structure carrying properties needed to start a DataAcquisition.
     *
     * This information can be serialized and deserialized to facilitate persitant storage.
     *
     * @seealso daq::Status
     * @ingroup daq_ocm_libdaq
     */
    struct DaqProperties {
        DaqProperties() = default;
        DaqProperties(DaqProperties const&) = default;
        DaqProperties(DaqProperties&&) = default;
        DaqProperties& operator=(DaqProperties&&) = default;
        DaqProperties& operator=(DaqProperties const&) = default;
 
        std::string id;
        /**
         * User defined process name.
         */
        std::string process_name;
 
        /**
         * Data product file name prefix
         */
        std::string dp_name_prefix;
        /**
         * Root directory for OCM data product part output
         */
        std::string ocm_dppart_root;
        std::vector<PrimSource> prim_sources;
        std::vector<MetaSource> meta_sources;
        /**
         * Initial list of keywords provided by user when starting data acquisitions.
         */
        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);
    };
}
 
#endif // #ifndef OCM_DAQ_DAQ_PROPERTIES_HPP_