dictKeywordFormatter.hpp

Go to the documentation of this file.

/**
 * @file
 * @copyright
 * (c) Copyright ESO 2024
 * All Rights Reserved
 * ESO (eso.org) is an Intergovernmental Organisation, and therefore special legal conditions apply.
 */
#ifndef OCM_SERVER_DICTKEYWORDFORMATTER_HPP
#define OCM_SERVER_DICTKEYWORDFORMATTER_HPP
 
#include <daq/fits/keyword.hpp>
 
#include <core/dit/did/did.hpp>
 
namespace daq {
 
/**
 * Format (and validate) keyword according to loaded dictionary. Unknown keywords are rejected.
 */
class DictKeywordFormatter : public fits::KeywordFormatter {
public:
    DictKeywordFormatter() = default;
 
    /**
     * Load dictionaries or throw exception if not found.
     * @param dictionaries List of dictionaries to load.
     */
    void Load(std::vector<std::string> const& dictionaries);
 
    /**
     * @return List of loaded dictionaries.
     */
    auto GetDictionaries() const noexcept -> std::vector<std::string> const&;
 
    /**
     * @return List of loaded dictionaries as comma separated string.
     */
    auto GetDictionariesNames() const -> std::string;
 
    /**
     * Look up keyword from loaded dictionaries and format using `Format(fits::KeywordVariant
     * const&, core::dit::did::Record cont&)`.
     *
     * @param keyword keyword to format.
     * @throw UnknownKeyword if keyword is not in any of the loaded dictionaries.
     * @throw InvalidKeyword if keyword fails validation.
     */
    auto Format(fits::KeywordVariant const& keyword) const -> fits::LiteralKeyword override;
 
private:
    std::vector<std::string> m_dictionaries;
    core::dit::did::Did m_did;
};
 
/**
 * Format and validates using keyword dictionary record.
 *
 * Given the keyword the function will check:
 * - Value type is compatible (int64_t and uint64_t can be promoted to double).
 * - Parse value if value type is a double.
 * - If format specifier is provided:
 *   Reformat value for floating point type according to format specification.
 * - Use comment from @a record if none is provided already.
 *
 * @note
 * ditlib from ifw-core does not make a distinction between HIERARCH ESO keywords and
 * FITS value keywords.
 *
 * When parsing floating point value from a LiteralKeyword there is no check that the parsed
 * value has more or equal number of decimal places than the requested formatting.
 */
auto Format(fits::KeywordVariant const& kw, core::dit::did::Record const& record)
    -> fits::LiteralKeyword;
 
}  // namespace daq
#endif  //  OCM_SERVER_DICTKEYWORDFORMATTER_HPP