SourceID.hpp

Go to the documentation of this file.

 
#ifndef DAQDATAFORMATS_INCLUDE_DAQDATAFORMATS_SOURCEID_HPP_
#define DAQDATAFORMATS_INCLUDE_DAQDATAFORMATS_SOURCEID_HPP_
 
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <iomanip>
#include <istream>
#include <limits>
#include <ostream>
#include <sstream>
#include <string>
#include <tuple>
 
namespace dunedaq::daqdataformats {

struct SourceID
{
 
  using Version_t = uint16_t;   // NOLINT(build/unsigned)
  using Subsystem_t = uint16_t; // NOLINT(build/unsigned)
  using ID_t = uint32_t;        // NOLINT(build/unsigned)

  enum class Subsystem : Subsystem_t
  {
    kUnknown = 0,
    kDetectorReadout = 1,
    kHwSignalsInterface = 2,
    kTrigger = 3,
    kTRBuilder = 4
  };
 
  // Taking SourceID as the direct successor of GeoID which had version 1
  static constexpr Version_t s_source_id_version = 2;
 
  static constexpr ID_t s_invalid_id = std::numeric_limits<ID_t>::max();
 
  Version_t version{ s_source_id_version };

  Subsystem subsystem{ Subsystem::kUnknown };

  ID_t id{ s_invalid_id };
 
  SourceID() = default;
 
  SourceID(const Subsystem& subsystem_arg, const ID_t& id_arg)
    : subsystem(subsystem_arg)
    , id(id_arg)
  {
  }
 
  std::string to_string() const
  {
    std::ostringstream ostr;
    ostr << subsystem_to_string(subsystem) << "_0x" << std::hex << std::setfill('0') << std::setw(2 * sizeof(id)) << id;
    return ostr.str();
  }
 
  bool is_in_valid_state() const noexcept { return subsystem != Subsystem::kUnknown && id != s_invalid_id; }

  bool operator<(const SourceID& other) const noexcept;
  bool operator!=(const SourceID& other) const noexcept;
  bool operator==(const SourceID& other) const noexcept;
 
  static std::string subsystem_to_string(const Subsystem& type);
  static Subsystem string_to_subsystem(const std::string& typestring);
};
 
inline bool
SourceID::operator<(const SourceID& other) const noexcept
{
  return std::tuple(subsystem, id) < std::tuple(other.subsystem, other.id);
}
 
} // namespace dunedaq::daqdataformats
 
#include "detail/SourceID.hxx"
 
#endif // DAQDATAFORMATS_INCLUDE_DAQDATAFORMATS_SOURCEID_HPP_