dpPart.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_common_libdaq
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Contains declaration for DpPart
 */
#ifndef OCM_DAQ_DP_PART_HPP_
#define OCM_DAQ_DP_PART_HPP_
 
#include <iosfwd>
#include <string>
#include <variant>
#include <vector>
 
#include <daq/fits/keyword.hpp>
 
namespace daq {
 
/**
 * Provides information of the location and source of a FITS file or keywords produced by a data
 * acquisition.
 *
 * @ingroup daq_common_libdaq
 */
class DpPart {
public:
    DpPart(std::string source_name, std::string path) noexcept;
    DpPart(std::string source_name, fits::KeywordVector keywords) noexcept;
    DpPart() = default;
    DpPart(DpPart const&) = default;
    DpPart(DpPart&&) noexcept = default;
    DpPart& operator=(DpPart const&) = default;
    DpPart& operator=(DpPart&&) noexcept = default;
 
    bool operator==(DpPart const& rhs) const noexcept;
    bool operator!=(DpPart const& rhs) const noexcept;
 
    using PartTypes = std::variant<std::string, fits::KeywordVector>;
 
    /**
     * Source name of the part
     */
    auto SourceName() const noexcept -> std::string const& {
        return m_source_name;
    }
    auto SourceName() noexcept -> std::string & {
        return m_source_name;
    }
 
    /**
     * Holds a std::string path `[[user]@host:]path` or FITS keywords.
     */
    auto Part() const noexcept -> PartTypes const& {
        return m_part;
    }
    auto Part() noexcept -> PartTypes& {
        return m_part;
    }
 
private:
    std::string m_source_name;
    PartTypes m_part;
};
 
using DpParts = std::vector<DpPart>;
 
std::ostream& operator<<(std::ostream& os, DpPart const& part) noexcept;
 
}  // namespace daq
 
#endif  // #define OCM_DAQ_DP_PART_HPP_