HLTPathStatus.h

Go to the documentation of this file.

#ifndef canvas_Persistency_Common_HLTPathStatus_h
#define canvas_Persistency_Common_HLTPathStatus_h

#include "canvas/Persistency/Common/HLTenums.h"

#include <cassert>
#include <cstdint>

namespace art {
  class HLTPathStatus {

  private:
    // packed status of trigger path [unsigned char is too small]
    std::uint16_t status_;
    // bits 0- 1 (0-    3): HLT state
    // bits 2-16 (0-16383): index of module on path making path decision

  public:
    // constructor
    HLTPathStatus(const hlt::HLTState state = hlt::Ready,
                  const unsigned int index = 0)
      : status_(index * 4 + state)
    {
      assert(state < hlt::UNKNOWN);
      assert(index < 16384);
    }

    // get state of path
    hlt::HLTState
    state() const
    {
      return (static_cast<hlt::HLTState>(status_ % 4));
    }
    // get index of module giving the status of this path
    unsigned int
    index() const
    {
      return (static_cast<unsigned int>(status_ / 4));
    }
    // reset this path
    void
    reset()
    {
      status_ = 0;
    }

    // was this path run?
    bool
    wasrun() const
    {
      return (state() != hlt::Ready);
    }
    // has this path accepted the event? If the path was not run, the
    // answer is, "yes."
    bool
    accept() const
    {
      return ((state() == hlt::Pass) || !wasrun());
    }
    // has this path encountered an error (exception)?
    bool
    error() const
    {
      return (state() == hlt::Exception);
    }

  }; // HLTPathStatus

} // art

  // ======================================================================

#endif /* canvas_Persistency_Common_HLTPathStatus_h */

// Local Variables:
// mode: c++
// End: