Chain.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
/**********************************************************************************
 * @Project: HLT SteeringEvent
 * @Package: TrigSteeringEvent
 * @class  : Chain
 *
 * @brief  chain of signatures
 *
 * @author Till Eifert     <Till.Eifert@cern.ch>     - U. of Geneva, Switzerland
 * @author Nicolas Berger  <Nicolas.Berger@cern.ch>  - CERN
 * moved from TrigSteering package
 *
 * File and Version Information:
 **********************************************************************************/
 
#ifndef TRIGSTEERINGEVENT_CHAIN_H
#define TRIGSTEERINGEVENT_CHAIN_H
 
#include "TrigSteeringEvent/Enums.h"
#include "TrigConfHLTData/HLTChain.h"
 
#ifdef XAOD_STANDALONE
#include "AsgMessaging/MsgStream.h"
#include "AsgMessaging/MsgStreamMacros.h"
#endif
#ifndef XAOD_STANDALONE
#include "GaudiKernel/MsgStream.h"
#include "AthenaBaseComps/AthMsgStreamMacros.h"
#endif
 
#include <vector>
#include <stdint.h>
#include <string>
#include <iomanip>
#include <iosfwd>
 
class MsgStream;
 
 
namespace HLT {
 
  static const std::string no_config = "no config";
 
  // taht is for backward compatibility of TDT, once new TDT will be available it can be removed from steering
  enum ChainStatus { ChainInvalid=0, ConfigOnlyChain, ChainOK };

  class Chain
  {
 
  public:
 
 
    //Chain( const std::vector<uint32_t>& serialData ); //!< constructor from serialized data
    
    Chain( uint32_t serialData ); 
 
    Chain(const TrigConf::HLTChain* configChain);
 
    ~Chain(){}
 
 
    const TrigConf::HLTChain* getConfigChain() const { return m_configChain; } 
 
 
    bool chainPassedRaw() const { return m_passedRaw; }
    bool chainPassed()    const;
 
 
    bool isPassedThrough() const { return m_passThrough; }  
    bool isPrescaled()     const { return m_prescaled;   }  
    bool isResurrected()   const { return m_resurrected; }  
 
    // For Lvl Converters
 
    float prescaleFactor()                  const { return (m_configChain ? m_configChain->prescale() : -1.); } 
    float passThroughFactor()               const { return (m_configChain ? m_configChain->pass_through() : -1.); }  
    unsigned int getChainCounter()          const { return m_chain_counter; }   
    const std::string&  getChainName()      const { return (m_configChain ? m_configChain->chain_name(): no_config); }    
    const std::string&  getLowerChainName() const { return (m_configChain ? m_configChain->lower_chain_name(): no_config); }    
    int  getEBAfterStep()                   const { return (m_configChain ? m_configChain->EB_after_step() : -1.); }    
    std::vector<size_t> getLegMultiplicities() const { return (m_configChain ? m_configChain->leg_multiplicities() : std::vector<size_t>()); }    
    bool nextStepAfterEB()                  const { return ((getChainStep()+1) > getEBAfterStep()) && (getEBAfterStep()>0.); } 
    bool isMerged()                         const { return (m_configChain ? (m_configChain->level()=="HLT") : false);}; 
 
    unsigned int getChainHashId()  const { return (m_configChain ? m_configChain->chain_hash_id() : 0); } 
    HLT::ErrorCode getErrorCode()  const { return m_errorCode; }          
    int getChainStep()             const { return m_currentStep; }        
 

    template <class stream>
    void print(stream& os) const
    {
      os << "Counter = " << std::setw(4) <<getChainCounter()
     << " success (raw) = " << chainPassedRaw()
     << " EBstep = " << getEBAfterStep()
     << " pass-through = " << isPassedThrough()
     << " prescaled = " << isPrescaled()
     << " rerun = " << isResurrected()
     << " lastActiveStep = " << getChainStep()
     << " name = " << std::setw(35) << getChainName() 
     << " EC = "<< strErrorCode(getErrorCode()) ;
    }
 
    ErrorCode serialize( std::vector<uint32_t>& output ) const; 
 
    ErrorCode deserialize(uint32_t chainWord); 
 
    ErrorCode setDecisions(bool passedraw, bool passedthrough, bool prescaled, bool resurrected); 
 
 
    static unsigned int inquireChainCounter(uint32_t chainWord); 
 
    ChainStatus getStatus() const { return m_status; } 
 
    bool reset(); 
 
  protected:
 
 
    void setStatus(ChainStatus s) { m_status = s; }
 
    const TrigConf::HLTChain* m_configChain; 
    unsigned int m_chain_counter;       
    ErrorCode m_errorCode;        
    bool m_passedRaw;
    bool m_passThrough; 
    bool m_prescaled;   
    bool m_resurrected; 
    int  m_currentStep;  
 
  private:
    ChainStatus m_status; 
 
  };
 

MsgStream& operator << (MsgStream&, const Chain&);
std::ostream& operator << (std::ostream&, const Chain&);
 
} // end of namespace
 
 
#endif