FrameConcepts.hpp

Go to the documentation of this file.

 
#ifndef FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_FRAMECONCEPTS_HPP_
#define FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_FRAMECONCEPTS_HPP_
 
#include "detdataformats/DAQEthHeader.hpp"
#include "detdataformats/DAQHeader.hpp"
 
#include <concepts>
#include <cstdint>
 
namespace dunedaq::fddetdataformats {
 
template<typename T>
concept HasGetADC = std::is_member_function_pointer_v<decltype(&T::get_adc)>;
 
template<typename T>
concept HasSetADC = std::is_member_function_pointer_v<decltype(&T::set_adc)>;
 
template<typename T>
concept HasDAQHeader = requires(const T t) { t.daq_header; } &&
                       (std::same_as<decltype(std::declval<T>().daq_header), dunedaq::detdataformats::DAQEthHeader> ||
                        std::same_as<decltype(std::declval<T>().daq_header), dunedaq::detdataformats::DAQHeader>);
 
template<typename T>
concept HasFrameHeader = requires(const T t) { t.header; }; // NOLINT(readability/braces)
 
// Instead of std::totally_ordered, this just literally only requires the "<" operator
template<typename T>
concept HasLessThan = requires(const T a, const T b) {
  { a < b } -> std::convertible_to<bool>;
}; // NOLINT(readability/braces)
 
template<typename T>
concept HasNoCompilerPadding = requires {
  // "convertible_to" is used rather than "same_as" because s_expected_bytes is typically constexpr
  { T::s_expected_bytes } -> std::convertible_to<std::size_t>;
} && (T::s_expected_bytes == sizeof(T));
 
template<typename T>
concept HasGetTimestamp = requires(const T ct) {
  { ct.get_timestamp() } -> std::same_as<uint64_t>; // NOLINT(build/unsigned)
}; // NOLINT(readability/braces)
 
template<typename T>
concept HasSetTimestamp = requires(T t, uint64_t ts) // NOLINT(build/unsigned)
{
  { t.set_timestamp(ts) } -> std::same_as<void>;
}; // NOLINT(readability/braces)
 
// TODO: John Freeman (jcfree@fnal.gov), Jun-17-2026
 
// In the next two months, figure out a concept parallel to
// AdaptableFrameConcept which can be made specific to the type
// adapters in fdreadoutlibs (as opposed to, e.g.,
// TriggerPrimitiveTypeAdapter.hpp in trigger). This can include
// concepts commented out below like "has an ADC getter", etc.)
 
template<typename T>
concept AdaptableFrameConcept =
  HasNoCompilerPadding<T> && HasLessThan<T> &&
  //  HasGetADC<T> &&
  //  HasSetADC<T> &&
  //  HasDAQHeader<T> &&
  //  HasFrameHeader<T> &&
  HasGetTimestamp<T> && HasSetTimestamp<T> && std::is_standard_layout_v<T> && std::is_trivially_copyable_v<T>;
 
} // namespace dunedaq::fddetdataformats
 
#endif // FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_FRAMECONCEPTS_HPP_