dunedaq::daqdataformats::SourceID Struct Reference

SourceID is a generalized representation of the source of a piece of data in the DAQ. That source could be a physical location in the detector, a running process in the DAQ (e.g. a dataflow app, the source of a data request), etc. More...

#include <SourceID.hpp>

Public Types
enum class	Subsystem : Subsystem_t {   kUnknown = 0 , kDetectorReadout = 1 , kHwSignalsInterface = 2 , kTrigger = 3 ,   kTRBuilder = 4 }
	The Subsystem enum describes the kind of source we're dealing with. More...
using	Version_t = uint16_t
using	Subsystem_t = uint16_t
using	ID_t = uint32_t

Public Member Functions
	SourceID ()=default
	SourceID (const Subsystem &subsystem_arg, const ID_t &id_arg)
std::string	to_string () const
bool	is_in_valid_state () const noexcept
bool	operator< (const SourceID &other) const noexcept
	Comparison operators to allow SourceID to be used in std::map.
bool	operator!= (const SourceID &other) const noexcept
bool	operator== (const SourceID &other) const noexcept

Static Public Member Functions
static std::string	subsystem_to_string (const Subsystem &type)
static Subsystem	string_to_subsystem (const std::string &typestring)

Public Attributes
Version_t	version { s_source_id_version }
	Version number of the SourceID.
Subsystem	subsystem { Subsystem::kUnknown }
	The general subsystem of the source of the data.
ID_t	id { s_invalid_id }
	Unique identifier of the source of the data.

Static Public Attributes
static constexpr Version_t	s_source_id_version
	The version of this SourceID struct.
static constexpr ID_t	s_invalid_id = std::numeric_limits<ID_t>::max()
	A value for the id meant to convey that it doesn't identify a data source and shouldn't be worked with.

Detailed Description

SourceID is a generalized representation of the source of a piece of data in the DAQ. That source could be a physical location in the detector, a running process in the DAQ (e.g. a dataflow app, the source of a data request), etc.

Definition at line 31 of file SourceID.hpp.

Member Typedef Documentation

ID_t

using dunedaq::daqdataformats::SourceID::ID_t = uint32_t

Definition at line 36 of file SourceID.hpp.

Subsystem_t

using dunedaq::daqdataformats::SourceID::Subsystem_t = uint16_t

Definition at line 35 of file SourceID.hpp.

Version_t

using dunedaq::daqdataformats::SourceID::Version_t = uint16_t

Definition at line 34 of file SourceID.hpp.

Member Enumeration Documentation

Subsystem

enum class dunedaq::daqdataformats::SourceID::Subsystem : Subsystem_t

strong

The Subsystem enum describes the kind of source we're dealing with.

Enumerator
kUnknown
kDetectorReadout
kHwSignalsInterface
kTrigger
kTRBuilder

Definition at line 42 of file SourceID.hpp.

  {
    kUnknown = 0,
    kDetectorReadout = 1,
    kHwSignalsInterface = 2,
    kTrigger = 3,
    kTRBuilder = 4
  };

Constructor & Destructor Documentation

SourceID() [1/2]

dunedaq::daqdataformats::SourceID::SourceID ( )

default

SourceID() [2/2]

dunedaq::daqdataformats::SourceID::SourceID ( const Subsystem & subsystem_arg, const ID_t & id_arg )

inline

Definition at line 78 of file SourceID.hpp.

    : subsystem(subsystem_arg)
    , id(id_arg)
  {}

Member Function Documentation

is_in_valid_state()

bool dunedaq::daqdataformats::SourceID::is_in_valid_state ( ) const

inlinenoexcept

Definition at line 90 of file SourceID.hpp.

{ return subsystem != Subsystem::kUnknown && id != s_invalid_id; }

operator!=()

bool dunedaq::daqdataformats::SourceID::operator!= ( const SourceID & other ) const

inlinenoexcept

Definition at line 76 of file SourceID.hxx.

{
  return (*this) < other || other < (*this);
}

operator<()

bool dunedaq::daqdataformats::SourceID::operator< ( const SourceID & other ) const

inlinenoexcept

Comparison operators to allow SourceID to be used in std::map.

Definition at line 69 of file SourceID.hxx.

{
  return std::tuple(subsystem, id) < std::tuple(other.subsystem, other.id);
}

operator==()

bool dunedaq::daqdataformats::SourceID::operator== ( const SourceID & other ) const

inlinenoexcept

Definition at line 82 of file SourceID.hxx.

{
  return !((*this) != other);
}

string_to_subsystem()

SourceID::Subsystem dunedaq::daqdataformats::SourceID::string_to_subsystem ( const std::string & typestring )

inlinestatic

Definition at line 106 of file SourceID.hxx.

{
  if (typestring == "Detector_Readout")
    return Subsystem::kDetectorReadout;
  if (typestring == "HW_Signals_Interface")
    return Subsystem::kHwSignalsInterface;
  if (typestring == "Trigger")
    return Subsystem::kTrigger;
  if (typestring == "TR_Builder")
    return Subsystem::kTRBuilder;
 
  return Subsystem::kUnknown;
}

subsystem_to_string()

std::string dunedaq::daqdataformats::SourceID::subsystem_to_string ( const Subsystem & type )

inlinestatic

Definition at line 88 of file SourceID.hxx.

{
  switch (type) {
    case Subsystem::kUnknown:
      return "Unknown";
    case Subsystem::kDetectorReadout:
      return "Detector_Readout";
    case Subsystem::kHwSignalsInterface:
      return "HW_Signals_Interface";
    case Subsystem::kTrigger:
      return "Trigger";
    case Subsystem::kTRBuilder:
      return "TR_Builder";
  }
  return "Unknown";
}

to_string()

std::string dunedaq::daqdataformats::SourceID::to_string ( ) const

inline

Definition at line 83 of file SourceID.hpp.

  {
    std::ostringstream ostr;
    ostr << subsystem_to_string(subsystem) << "_0x" << std::hex << std::setfill('0') << std::setw(2 * sizeof(id)) << id;
    return ostr.str();
  }

Member Data Documentation

id

ID_t dunedaq::daqdataformats::SourceID::id { s_invalid_id }

Unique identifier of the source of the data.

Definition at line 74 of file SourceID.hpp.

{ s_invalid_id };

s_invalid_id

ID_t dunedaq::daqdataformats::SourceID::s_invalid_id = std::numeric_limits<ID_t>::max()

staticconstexpr

A value for the id meant to convey that it doesn't identify a data source and shouldn't be worked with.

Definition at line 60 of file SourceID.hpp.

s_source_id_version

Version_t dunedaq::daqdataformats::SourceID::s_source_id_version

staticconstexpr

Initial value:

=
    2

The version of this SourceID struct.

Definition at line 54 of file SourceID.hpp.

subsystem

Subsystem dunedaq::daqdataformats::SourceID::subsystem { Subsystem::kUnknown }

The general subsystem of the source of the data.

Definition at line 69 of file SourceID.hpp.

{ Subsystem::kUnknown };

version

Version_t dunedaq::daqdataformats::SourceID::version { s_source_id_version }

Version number of the SourceID.

Definition at line 65 of file SourceID.hpp.

{ s_source_id_version };

---

The documentation for this struct was generated from the following files:

• /github/workspace/dunedaq/sourcecode/daqdataformats/include/daqdataformats/SourceID.hpp
• /github/workspace/dunedaq/sourcecode/daqdataformats/include/daqdataformats/detail/SourceID.hxx