Revisit Fragment Error Bits

[bieryAtFnal]

As part of the discussion about adding the checking of FragmentErrorBits in our integrationtest infrastructure and the fact that TriggerCandidate fragments always have the kIncomplete bit set, we talked about having a future discussion about better names for those entities. And, a clear approach for informational bits vs. true errors, etc. This Issue is intended to remind us to have that future discussion.

15-Sep-2025, KAB: added DUNE-DAQ/datahandlinglibs#67 as a sub-issue of this Issue.

[eflumerf]

Setting this to be a "Large" change, as it is a direct data format change, and therefore will need to be communicated to the Offline as well.

[eflumerf]

Summary of Changes

In #78

• Fragment::error_bits has been renamed to Fragment::status_bits
• TriggerRecordHeaderData::error_bits has been renamed to TriggerRecordHeaderData::status_bits
• FragmentErrorBits enum renamed to FragmentStatusBits
  • kDataNotFound renamed to kLatencyBufferEmpty, doc string updated
  • kInvalidWindow renamed to kInvalidRequestWindow
  • bits 3-6 assigned new values "kRequestTimeout", "kRequestWindowBeforeBuffer", "kRequestWindowAfterBuffer", and "kEmptyFragment"
• TriggerRecordErrorBits enum renamed to TriggerRecordStatusBits
  • Doc string for kIncomplete updated for clarity
• Documentation, tests, and python bindings updated for new names.

In DUNE-DAQ/datahandlinglibs#123

• Updated DefaultRequestHandlerModel.hxx and EmptyFragmentRequestHandlerModel.hxx to use new FragmentStatusBits values
  • EmptyFragmentRequestHandlerModel sets kEmptyFragment instead of kDataNotFound for all generated Fragments
  • DefaultRequestHandlerModel uses the following updated status flags:
    • When creating an empty Fragment: kDataNotFound -> kEmptyFragment
    • When latency buffer is empty: kDataNotFound -> kLatencyBufferEmpty
    • When request is wholly before latency buffer: kDataNotFound -> kEmptyFragment & kRequestWindowBeforeBuffer
    • When request is partially before latency buffer: kIncomplete & kDataNotFound -> kIncomplete & kRequestWindowBeforeBuffer
    • When request is partially fulfilled: kIncomplete -> kIncomplete & kRequestWindowAfterBuffer
    • When request is wholly after latency bufer: kDataNotFound -> kEmptyFragment & kRequestWindowAfterBuffer
    • When data search returns unknown result: kDataNotFound -> kEmptyFragment

In DUNE-DAQ/snbmodules#23

• Similar changes as in datahandlinglibs for snbmodules' SNBRequestHandlerModel.hxx

In DUNE-DAQ/dfmodules#474, DUNE-DAQ/dfmessages#77, DUNE-DAQ/integrationtest#142

• Updated usages to account for renames