json.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_ocm_libfits
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Contains data structure for FITS keywords
 */
#ifndef DAQ_OCM_DAQ_FITS_JSON_HPP_
#define DAQ_OCM_DAQ_FITS_JSON_HPP_
#include <nlohmann/json.hpp>
#include <variant>
#include <vector>
 
#include "keyword.hpp"
 
namespace daq::fits {
 
/**
 * Parse and return FITS keywords.
 *
 * Example string:
 *
 * @code
 * auto keywords = R"([
 *  {
 *     "type":"valueKeyword",
 *     "name":"OBJECT",
 *     "value":"OBJECT,SKY"
 *  },
 *  ...
 *  ]");
 * auto res = ParseJsonKeywords(keywords);
 * @endcode
 *
 * @param keywords JSON encoded string of keywords
 *
 * @throws std::invalid_argument on schema validation error.
 * @throws nlohmann::json::exception on JSON parsing error.
 */
std::vector<KeywordVariant> ParseJsonKeywords(char const* keywords);
 
/**
 * Parse and return FITS keywords.
 *
 * @param keywords JSON object containing FITS keywords.
 *
 * @throws std::invalid_argument on schema validation error.
 */
std::vector<KeywordVariant> ParseJsonKeywords(
    nlohmann::json const& keywords,
    nlohmann::json_pointer<nlohmann::json> const& = nlohmann::json_pointer<nlohmann::json>());
 
/**
 * SerializeJsons the keyword value variant to JSON.
 *
 * @param value Value to serialize.
 * @return JSON value.
 */
nlohmann::json SerializeJsonKeywordValue(BasicKeywordBase::ValueType const& value);
 
/**
 * SerializeJsons keyword to JSON.
 *
 * @param keyword keyword to serialize.
 * @returns JSON object.
 */
nlohmann::json SerializeJsonKeyword(KeywordVariant const& keyword);
 
/**
 * SerializeJsons keyword to JSON.
 *
 * @param keywords keywords to serialize.
 * @returns JSON array of keywords.
 */
nlohmann::json SerializeJsonKeywords(std::vector<KeywordVariant> const& keywords);
 
}  // namespace daq::fits
 
#endif  // #define DAQ_OCM_DAQ_FITS_JSON_HPP_