dpSpec.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_libjson
 * @copyright ESO - European Southern Observatory
 */
#ifndef DAQ_DPM_DP_SPEC_HPP
#define DAQ_DPM_DP_SPEC_HPP
#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
#include <variant>
#include <vector>
 
#include <nlohmann/json.hpp>
 
#include <daq/fits/keyword.hpp>
#include <daq/json/commonSpecTypes.hpp>
#include <daq/json/schemaError.hpp>
 
namespace daq::json {
 
struct DpSpecError : SchemaError {
    using SchemaError::SchemaError;
};
 
/**
 * Close representation of the JSON structure but with stronger types.
 */
struct DpSpec {
    struct Target {
        std::string file_id;
        /**
         * Optioal user chosen file prefix to make it easier to identify the produced file.
         */
        std::string file_prefix;
        std::optional<FitsFileSource> source;
    };
 
    using SourceTypes = std::variant<FitsKeywordsSource, FitsFileSource>;
 
    /**
     * DAQ id.
     */
    std::string id;
    /**
     * Describes target which will become the data produtc.
     */
    Target target;
 
    /**
     * List of sources to create data product from.
     */
    std::vector<SourceTypes> sources;
 
    /**
     * Ordered container of receivers where to deliver the target data product.
     */
    ReceiverList receivers;
};
 
/**
 * Parse JSON to construct the DpSpec structure
 *
 * @param spec Data Product Specification to parse.
 * @throw DpSpecError if JSON structure is invalid. Exception may be nested.
 */
DpSpec ParseDpSpec(nlohmann::json const& spec);
 
/**
 * Describes parsed location string into its components "host" and "path".
 */
struct Location {
    /**
     * @returns `host:path` if host is not empty, otherwise just `path`
     */
    std::string RsyncPath() const;
    std::string host;
    std::filesystem::path path;
};
 
/**
 * Parse location string from DpSpec into component parts.
 *
 * Location string use the format `host:path`, e.g. `10.0.0.1:/path/to/file` with host being
 * optional.
 */
Location ParseSourceLocation(std::string const& location);
 
void to_json(nlohmann::json& j, DpSpec const& s);               // NOLINT
void to_json(nlohmann::json& j, DpSpec::Target const& s);       // NOLINT
void to_json(nlohmann::json& j, DpSpec::SourceTypes const& s);  // NOLINT
 
}  // namespace daq::json
 
#endif  // #ifndef DAQ_DPM_DP_SPEC_HPP