EventIDBase.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once

 
#include <cstdint>
#include <iomanip>
#include <iostream>
#include <tuple>
 
#include <GaudiKernel/compose.h>
namespace details {
  template <typename lambda>
  struct arg_helper : public arg_helper<decltype( &lambda::operator() )> {};
  template <typename T, typename Ret, typename Arg>
  struct arg_helper<Ret ( T::* )( Arg ) const> {
    using type = Arg;
  };
 
  // given a unary lambda whose argument is of type Arg_t,
  // argument_t<lambda> will be equal to Arg_t
  template <typename lambda>
  using argument_t = typename arg_helper<lambda>::type;
 
  template <typename Fun>
  auto add_deref( Fun f ) {
    return compose( f, [=]( auto*... p ) { return f( *p... ); } );
  }
 
  template <typename Proj, typename Cmp = std::greater<>>
  auto make_cmp( Proj p, Cmp cmp = {} ) {
    static_assert( std::is_reference_v<argument_t<Proj>>, "must be a reference" );
    static_assert( std::is_const_v<std::remove_reference_t<argument_t<Proj>>>, "must be const" );
    return [=]( argument_t<Proj> lhs, argument_t<Proj> rhs ) { return cmp( p( lhs ), p( rhs ) ); };
  }
} // namespace details

 
class EventIDBase {
public:
  typedef unsigned int number_type;
  typedef uint64_t     event_number_t;
 
  static const number_type    UNDEFNUM;
  static const event_number_t UNDEFEVT;
 
  friend class EventIDRange;
 
public:

  EventIDBase() {}
  EventIDBase( number_type run_number, event_number_t event_number, number_type time_stamp = UNDEFNUM,
               number_type time_stamp_ns_offset = 0, number_type lumi_block = UNDEFNUM,
               number_type bunch_crossing_id = 0 );
 
  EventIDBase( std::tuple<number_type, number_type, event_number_t> run_lumi_ev,
               std::tuple<number_type, number_type> time_stamp, number_type bunch_crossing_id );
 
  // Use default copy constructor.
  virtual ~EventIDBase() = default;

  number_type run_number() const { return m_run_number; }

  event_number_t event_number() const { return m_event_number; }

  number_type time_stamp() const { return m_time_stamp; }

  number_type time_stamp_ns_offset() const { return m_time_stamp_ns_offset; }

  number_type lumi_block() const { return m_lumi_block; }

  number_type bunch_crossing_id() const { return m_bunch_crossing_id; }

  void set_run_number( number_type runNumber ) {
    m_run_number = runNumber;
    if ( m_event_number != UNDEFEVT ) setRE();
    if ( m_lumi_block != UNDEFNUM ) setRL();
  }

  void set_event_number( event_number_t eventNumber ) {
    m_event_number = eventNumber;
    if ( m_run_number != UNDEFNUM ) setRE();
    if ( m_lumi_block != UNDEFNUM ) setLE();
  }

  void set_time_stamp( number_type timeStamp ) {
    m_time_stamp = timeStamp;
    setTS();
  }

  void set_time_stamp_ns_offset( number_type timeStampNs ) { m_time_stamp_ns_offset = timeStampNs; }

  void set_lumi_block( number_type lumiBlock ) {
    m_lumi_block = lumiBlock;
    if ( m_run_number != UNDEFNUM ) setRL();
    if ( m_event_number != UNDEFEVT ) setLE();
  }

  void set_bunch_crossing_id( number_type bcid ) { m_bunch_crossing_id = bcid; }

  friend bool operator==( const EventIDBase& lhs, const EventIDBase& rhs );
  friend bool operator<( const EventIDBase& lhs, const EventIDBase& rhs );
  friend bool operator>( const EventIDBase& lhs, const EventIDBase& rhs ) { return rhs < lhs; }
  friend bool operator!=( const EventIDBase& lhs, const EventIDBase& rhs ) { return !( lhs == rhs ); }
  friend bool operator<=( const EventIDBase& lhs, const EventIDBase& rhs ) { return !( lhs > rhs ); }
  friend bool operator>=( const EventIDBase& lhs, const EventIDBase& rhs ) { return !( lhs < rhs ); }
 
  friend EventIDBase min( const EventIDBase& lhs, const EventIDBase& rhs );
  friend EventIDBase max( const EventIDBase& lhs, const EventIDBase& rhs );
 
  bool isRunEvent() const { return m_type & RunEvent; }
  bool isTimeStamp() const { return m_type & TimeStamp; }
  bool isLumiEvent() const { return m_type & LumiEvent; }
  bool isRunLumi() const { return m_type & RunLumi; }
  bool isValid() const { return m_type != Invalid; }

  friend std::ostream& operator<<( std::ostream& os, const EventIDBase& rhs );
 
  static auto SortByTimeStamp() {
    return ::details::add_deref( ::details::make_cmp(
        []( const EventIDBase& e ) { return std::tie( e.m_time_stamp, e.m_time_stamp_ns_offset ); } ) );
  }
 
  static auto SortByRunEvent() {
    return ::details::add_deref(
        ::details::make_cmp( []( const EventIDBase& e ) { return std::tie( e.m_run_number, e.m_event_number ); } ) );
  }
 
  static auto SortByLumiEvent() {
    return ::details::add_deref(
        ::details::make_cmp( []( const EventIDBase& e ) { return std::tie( e.m_lumi_block, e.m_event_number ); } ) );
  }
 
  static auto SortByRunLumi() {
    return ::details::add_deref(
        ::details::make_cmp( []( const EventIDBase& e ) { return std::tie( e.m_run_number, e.m_lumi_block ); } ) );
  }
 
private:
  enum Type { Invalid = 0, RunEvent = 1 << 1, TimeStamp = 1 << 2, LumiEvent = 1 << 3, RunLumi = 1 << 4 };
 
  unsigned m_type{ Invalid };
 
  void setRE() { m_type |= RunEvent; }
  void setTS() { m_type |= TimeStamp; }
  void setLE() { m_type |= LumiEvent; }
  void setRL() { m_type |= RunLumi; }

  number_type m_run_number{ UNDEFNUM };

  event_number_t m_event_number{ UNDEFEVT };

  number_type m_time_stamp{ UNDEFNUM };

  number_type m_time_stamp_ns_offset{ UNDEFNUM };

  number_type m_lumi_block{ UNDEFNUM };

  number_type m_bunch_crossing_id{ UNDEFNUM };
 
  friend EventIDBase min( const EventIDBase& lhs, const EventIDBase& rhs ) {
 
    //"min" is easy b/c the numbers denoting invalidty for TS or Run/Event/LB are the
    // largest possible numbers, so naturally larger than any valid number
 
    return EventIDBase( std::min( std::tie( lhs.m_run_number, lhs.m_lumi_block, lhs.m_event_number ),
                                  std::tie( rhs.m_run_number, rhs.m_lumi_block, rhs.m_event_number ) ),
                        std::min( std::tie( lhs.m_time_stamp, lhs.m_time_stamp_ns_offset ),
                                  std::tie( rhs.m_time_stamp, rhs.m_time_stamp_ns_offset ) ),
                        lhs.bunch_crossing_id() // bcid doesn't really matter here
    );
  }
 
  friend EventIDBase max( const EventIDBase& lhs, const EventIDBase& rhs ) {
 
    //"max" is much trickier because we need to handle invalid number explicilty by
    // checking if a EventIDBase is TS or Run/Lumi
 
    std::tuple<EventIDBase::number_type, EventIDBase::number_type, EventIDBase::event_number_t> run_lumi_ev;
    std::tuple<EventIDBase::number_type, EventIDBase::number_type>                              time_stamp;
 
    if ( lhs.isTimeStamp() && rhs.isTimeStamp() ) { // both time-stamp, compare them
      time_stamp = std::max( std::tie( lhs.m_time_stamp, lhs.m_time_stamp_ns_offset ),
                             std::tie( rhs.m_time_stamp, rhs.m_time_stamp_ns_offset ) );
    } else if ( lhs.isTimeStamp() ) { // only lhs time-stamp: Use it
      time_stamp = std::tie( lhs.m_time_stamp, lhs.m_time_stamp_ns_offset );
    } else { // otherwise use rhs time-stamp which might be UNDEFNUM (in case both input values are Run-Lumi only)
      time_stamp = std::tie( rhs.m_time_stamp, rhs.m_time_stamp_ns_offset );
    }
 
    if ( lhs.isRunLumi() && rhs.isRunLumi() ) { // both run-lumi, compare them
      run_lumi_ev = std::max( std::tie( lhs.m_run_number, lhs.m_lumi_block, lhs.m_event_number ),
                              std::tie( rhs.m_run_number, rhs.m_lumi_block, rhs.m_event_number ) );
 
    } else if ( lhs.isRunLumi() ) { // only lhs run-lumi: Use it
      run_lumi_ev = std::tie( lhs.m_run_number, lhs.m_lumi_block, lhs.m_event_number );
    } else { // otherwise use rhs run-lumi which might be UNDEFNUM (in case both input values are TS-only)
      run_lumi_ev = std::tie( rhs.m_run_number, rhs.m_lumi_block, rhs.m_event_number );
    }
 
    return EventIDBase( run_lumi_ev, time_stamp, lhs.bunch_crossing_id() );
  }
 
  friend bool operator<( const EventIDBase& lhs, const EventIDBase& rhs ) {
    // first try ordering by timestamp if both are non-zero
    // then try ordering by run/lumi/event
    // this assumes that both EventIDBase have the same set of values defined.
 
    if ( lhs.isTimeStamp() && rhs.isTimeStamp() ) {
      return lhs.m_time_stamp < rhs.m_time_stamp;
    } else {
      return std::tie( lhs.m_run_number, lhs.m_lumi_block, lhs.m_event_number ) <
             std::tie( rhs.m_run_number, rhs.m_lumi_block, rhs.m_event_number );
    }
  }
 
  friend bool operator==( const EventIDBase& lhs, const EventIDBase& rhs ) {
    // We assume that equality via run/event/lumi numbers is sufficient
    return ( lhs.m_run_number == rhs.m_run_number && lhs.m_event_number == rhs.m_event_number &&
             lhs.m_lumi_block == rhs.m_lumi_block );
  }
 
  friend std::ostream& operator<<( std::ostream& os, const EventIDBase& rhs ) {
    if ( rhs.m_type == EventIDBase::Invalid ) return os << "[INVALID]";
 
    const char* separator = "";
    os << "[";
    if ( rhs.m_run_number != EventIDBase::UNDEFNUM ) {
      os << rhs.m_run_number;
      separator = ",";
    }
 
    if ( rhs.m_event_number != EventIDBase::UNDEFEVT ) {
      os << separator << rhs.m_event_number;
      separator = ",";
    }
 
    if ( rhs.isTimeStamp() ) {
      os << separator << "t:" << rhs.m_time_stamp;
      if ( rhs.m_time_stamp_ns_offset != 0 ) {
        os << "." << std::setfill( '0' ) << std::setw( 9 ) << rhs.m_time_stamp_ns_offset;
      }
      separator = ",";
    }
 
    if ( rhs.isLumiEvent() || rhs.isRunLumi() ) {
      os << separator << "l:" << rhs.m_lumi_block;
      separator = ",";
    }
 
    if ( rhs.m_bunch_crossing_id != 0 ) { os << separator << "b:" << rhs.m_bunch_crossing_id; }
    os << "]";
    return os;
  }
};