startDaqV2.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_libjson
 * @copyright
 * (c) Copyright ESO 2022
 * All Rights Reserved
 * ESO (eso.org) is an Intergovernmental Organisation, and therefore special legal conditions apply.
 */
#ifndef DAQ_STARTDAQV2_HPP
#define DAQ_STARTDAQV2_HPP
#include <chrono>
#include <optional>
#include <variant>
#include <vector>
 
#include <nlohmann/json.hpp>
 
#include <daq/json/commonSpecTypes.hpp>
#include <daq/json/schemaError.hpp>
 
namespace daq::json {
 
struct StartDaqV2SpecError : SchemaError {
    using SchemaError::SchemaError;
};
 
/**
 * Structure with a close mapping from JSON representation in the StartDaqV2 MAL request.
 *
 * Parts of this will end up being used in `CreateDataProductSpecification()`, like the keyword
 * rules.
 */
struct StartDaqV2Spec {
    struct DataSource {
        std::string source_name;
        std::string rr_uri;
        std::optional<InitialKeywords> initial_keywords;
        KeywordRules keyword_rules;
    };
    struct PrimaryDataSource final : DataSource {};
    struct MetadataSource final : DataSource {};
 
    using DataSourceTypes =
        std::variant<PrimaryDataSource, MetadataSource, FitsKeywordsSource, FitsFileSource>;
 
    struct MergeTarget {
        std::string source_name;
    };
 
    std::string id;
    std::vector<DataSourceTypes> sources;
    ReceiverList receivers;
 
    std::optional<MergeTarget> merge_target;
    std::optional<std::chrono::milliseconds> await_completion_interval;
    std::string file_prefix;
};
 
bool operator==(StartDaqV2Spec::PrimaryDataSource const& lhs,
                StartDaqV2Spec::PrimaryDataSource const& rhs) noexcept;
bool operator==(StartDaqV2Spec::MetadataSource const& lhs,
                StartDaqV2Spec::MetadataSource const& rhs) noexcept;
bool operator==(StartDaqV2Spec::MergeTarget const& lhs,
                StartDaqV2Spec::MergeTarget const& rhs) noexcept;
 
bool operator==(StartDaqV2Spec const& lhs, StartDaqV2Spec const& rhs) noexcept;
 
/**
 * Parse StartDaqSpec
 *
 * @throw StartDaqV2SpecError on invalid schema.
 */
StartDaqV2Spec ParseStartDaqV2Spec(nlohmann::json const& json);
 
/**
 * Serialize to JSON
 *
 * @param json
 * @param spec Specification to serialize
 */
void to_json(nlohmann::json& json, StartDaqV2Spec const& spec);  // NOLINT
 
}  // namespace daq::json
 
#endif  // DAQ_STARTDAQV2_HPP