HLT::Chain Class Reference

This class represents one chain of signatures, i.e. More...

#include <Chain.h>

Collaboration diagram for HLT::Chain:

Public Member Functions
	Chain (uint32_t serialData)
	constructor from serialized data
	Chain (const TrigConf::HLTChain *configChain)
	~Chain ()
const TrigConf::HLTChain *	getConfigChain () const
	get underlying ConfigChain
bool	chainPassedRaw () const
bool	chainPassed () const
bool	isPassedThrough () const
	is chain passed through ?
bool	isPrescaled () const
	is chain prescaled ?
bool	isResurrected () const
	is chain resurrected ?
float	prescaleFactor () const
	get prescale factor
float	passThroughFactor () const
	get pass-through factor
unsigned int	getChainCounter () const
	return the unique identifier of this Chain (uint)
const std::string &	getChainName () const
	return the Chain name (string)
const std::string &	getLowerChainName () const
	return the Chain name (string)
int	getEBAfterStep () const
	get EB_after_step
std::vector< size_t >	getLegMultiplicities () const
	get per leg multiplicity (Run3 only)
bool	nextStepAfterEB () const
	return whether next step requires EB (-1 means no EB called)
bool	isMerged () const
unsigned int	getChainHashId () const
	< return whether is a merged L2+EF chain
HLT::ErrorCode	getErrorCode () const
	return this Chain's most severe error code (from execution)
int	getChainStep () const
	return the current step of execution
template<class stream>
void	print (stream &os) const
	templated print stream method so that one can simply write std::cout << myChain << std::endl; or with the Gaudi Msg stram msgStram << myChain << ...
ErrorCode	serialize (std::vector< uint32_t > &output) const
	serialize this Chain into the given vector of uint's
ErrorCode	deserialize (uint32_t chainWord)
	deserialize this Chain from given vector of uint's
ErrorCode	setDecisions (bool passedraw, bool passedthrough, bool prescaled, bool resurrected)
	set bool decisions directly
ChainStatus	getStatus () const
	return Chain status
bool	reset ()
	restes the bits to the basic state

Static Public Member Functions
static unsigned int	inquireChainCounter (uint32_t chainWord)
	unpack chain counter from the serialized word

Protected Member Functions
void	setStatus (ChainStatus s)

Protected Attributes
const TrigConf::HLTChain *	m_configChain
	underlying Config Chain
unsigned int	m_chain_counter
	chain counter from configuration (copied here for speed)
ErrorCode	m_errorCode
	most severe error code of execution
bool	m_passedRaw
bool	m_passThrough
	Flagged as "passedThrough" for this event ?
bool	m_prescaled
	Flagged as "prescaled" for this event ?
bool	m_resurrected
	flag to mar that chain was originally prescalled but is reexecuted
int	m_currentStep
	Current step of this chain.

Private Attributes
ChainStatus	m_status
	Chain status, enum {ChainInvalid, ConfigOnlyChain, ChainOK }.

Detailed Description

This class represents one chain of signatures, i.e.

one signature for each step. The HLT::Chain class also holds information about its status, including prescales, pass-throughs etc.

Author

Till Eifert Till..nosp@m.Eife.nosp@m.rt@ce.nosp@m.rn.c.nosp@m.h

Nicolas Berger Nicol.nosp@m.as.B.nosp@m.erger.nosp@m.@cer.nosp@m.n.ch

Tomasz Bold Tomas.nosp@m.z.Bo.nosp@m.ld@ce.nosp@m.rn.c.nosp@m.h - U. of California - Irvine

Definition at line 63 of file Chain.h.

Constructor & Destructor Documentation

Chain() [1/2]

Chain::Chain

(

uint32_t

serialData

)

constructor from serialized data

Definition at line 27 of file Chain.cxx.

  : m_configChain(0) {
  reset();
  deserialize(serialData);
  setStatus(HLT::ChainInvalid);
} 

Chain() [2/2]

Chain::Chain

(

const TrigConf::HLTChain *

configChain

)

Definition at line 34 of file Chain.cxx.

  : m_configChain(configChain) 
  , m_chain_counter{0}
{
  if (configChain)
    m_chain_counter = m_configChain->chain_counter();
 
  reset();
  setStatus(HLT::ConfigOnlyChain);
}

~Chain()

HLT::Chain::~Chain ( )

inline

Definition at line 75 of file Chain.h.

{}

Member Function Documentation

chainPassed()

bool Chain::chainPassed

(

)

const

Definition at line 46 of file Chain.cxx.

                              { 
  return (chainPassedRaw() && (!isPrescaled()) && (!isResurrected())) || isPassedThrough(); 
} 

chainPassedRaw()

bool HLT::Chain::chainPassedRaw ( ) const

inline

Definition at line 81 of file Chain.h.

{ return m_passedRaw; }

deserialize()

HLT::ErrorCode Chain::deserialize

(

uint32_t

chainWord

)

deserialize this Chain from given vector of uint's

Definition at line 101 of file Chain.cxx.

{
  m_status = ChainOK;
  m_passedRaw = chainWord & (0x1);
  m_passThrough    = chainWord & (0x4);
  m_prescaled      = chainWord & (0x2);
  m_resurrected    = chainWord & (0x200);
  
  m_currentStep    = ( chainWord >> 3)   & 0x0000003f;
  m_chain_counter  = ( chainWord >> (3+7)) & 0x0000ffff;
  m_errorCode      = static_cast<HLT::ErrorCode>(( chainWord >> (3+7+16)) & 0x0000003f);
  /*
  // Put m_currentStep signatures in the vector
  for (unsigned int i = 0; i < static_cast<unsigned int>(m_currentStep); i++) m_signatures.push_back(0);
  
  // if chain didn't pass, add one more signature...
  if (!(chainWord & (0x1)))  m_signatures.push_back(0);
  */
 
  return HLT::OK;
}

getChainCounter()

unsigned int HLT::Chain::getChainCounter ( ) const

inline

return the unique identifier of this Chain (uint)

Definition at line 93 of file Chain.h.

getChainHashId()

unsigned int HLT::Chain::getChainHashId ( ) const

inline

< return whether is a merged L2+EF chain

return the Chain name's hash ID

Definition at line 101 of file Chain.h.

getChainName()

const std::string & HLT::Chain::getChainName ( ) const

inline

return the Chain name (string)

Definition at line 94 of file Chain.h.

getChainStep()

int HLT::Chain::getChainStep ( ) const

inline

return the current step of execution

Definition at line 103 of file Chain.h.

getConfigChain()

const TrigConf::HLTChain * HLT::Chain::getConfigChain ( ) const

inline

get underlying ConfigChain

Definition at line 78 of file Chain.h.

getEBAfterStep()

int HLT::Chain::getEBAfterStep ( ) const

inline

get EB_after_step

Definition at line 96 of file Chain.h.

getErrorCode()

HLT::ErrorCode HLT::Chain::getErrorCode ( ) const

inline

return this Chain's most severe error code (from execution)

Definition at line 102 of file Chain.h.

getLegMultiplicities()

std::vector< size_t > HLT::Chain::getLegMultiplicities ( ) const

inline

get per leg multiplicity (Run3 only)

Definition at line 97 of file Chain.h.

getLowerChainName()

const std::string & HLT::Chain::getLowerChainName ( ) const

inline

return the Chain name (string)

Definition at line 95 of file Chain.h.

getStatus()

ChainStatus HLT::Chain::getStatus ( ) const

inline

return Chain status

Definition at line 134 of file Chain.h.

inquireChainCounter()

unsigned int HLT::Chain::inquireChainCounter ( uint32_t chainWord )

static

unpack chain counter from the serialized word

Definition at line 123 of file Chain.cxx.

                                                             {
  return ( chainWord >> (3+7)) & 0x0000ffff;
}

isMerged()

bool HLT::Chain::isMerged ( ) const

inline

Definition at line 99 of file Chain.h.

{ return (m_configChain ? (m_configChain->level()=="HLT") : false);}; 

isPassedThrough()

bool HLT::Chain::isPassedThrough ( ) const

inline

is chain passed through ?

Definition at line 85 of file Chain.h.

isPrescaled()

bool HLT::Chain::isPrescaled ( ) const

inline

is chain prescaled ?

Definition at line 86 of file Chain.h.

isResurrected()

bool HLT::Chain::isResurrected ( ) const

inline

is chain resurrected ?

Definition at line 87 of file Chain.h.

nextStepAfterEB()

bool HLT::Chain::nextStepAfterEB ( ) const

inline

return whether next step requires EB (-1 means no EB called)

Definition at line 98 of file Chain.h.

passThroughFactor()

float HLT::Chain::passThroughFactor ( ) const

inline

get pass-through factor

Definition at line 92 of file Chain.h.

prescaleFactor()

float HLT::Chain::prescaleFactor ( ) const

inline

get prescale factor

Definition at line 91 of file Chain.h.

print()

template<class stream>

void HLT::Chain::print ( stream & os ) const

inline

templated print stream method so that one can simply write std::cout << myChain << std::endl; or with the Gaudi Msg stram msgStram << myChain << ...

Definition at line 112 of file Chain.h.

    {
      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()) ;
    }

reset()

bool HLT::Chain::reset

(

)

restes the bits to the basic state

Definition at line 127 of file Chain.cxx.

                     {
  m_errorCode   = HLT::OK;
  m_passedRaw   = false;
  m_passThrough = false;
  m_prescaled   = false;
  m_resurrected = false;
  m_currentStep = 0;
  return true;
}

serialize()

HLT::ErrorCode Chain::serialize

(

std::vector< uint32_t > &

output

)

const

serialize this Chain into the given vector of uint's

Definition at line 52 of file Chain.cxx.

{
  // Chain serialized structure: 1 word per Chain
  // 1 bit: active ?  (before prescale and passThrough)
  // 1 bit: prescaled ?
  // 1 bit: passedThrough ?
  // 7 bit: last active step => [0,127]
  // 16 bit: chainCounter    => [0,65535]
  // 6 bit: ErrorCode        => [0,63]
 
  // serialize data: first 3 bits for Active, Prescaled, passThrough bits
  uint32_t chainWord = 0;
  if (chainPassedRaw())  chainWord |= 0x1;
  if (isPrescaled())     chainWord |= 0x2;
  if (isPassedThrough()) chainWord |= 0x4;
 
  // next, 6 bits for the last active step (64 steps)
  chainWord |= ((m_currentStep & 0x0000003f) << 3);
 
  
  if ( isResurrected()) chainWord |= 0x200;
  
  // next, 16 bits for the chain counter
  chainWord |= ((getChainCounter() & 0x0000ffff) << (3+6+1));
 
  // next, 6 bits for the errorCode
  chainWord |= ((m_errorCode & 0x0000003f) << (3+6+1+16));
 
  output.push_back(chainWord);
 
  return HLT::OK;
}

setDecisions()

HLT::ErrorCode Chain::setDecisions	(	bool	passedraw,
		bool	passedthrough,
		bool	prescaled,
		bool	resurrected )

set bool decisions directly

Definition at line 85 of file Chain.cxx.

{
  m_status = ChainOK;
  m_passedRaw = passedraw;
  m_passThrough    = passedthrough;
  m_prescaled      = prescaled;
  m_resurrected    = resurrected;
 
  // can't deduce the following
  // m_currentStep    = 0; // can't deduce
  // m_chain_counter  = ( chainWord >> (3+7)) & 0x0000ffff;
  // m_errorCode      = static_cast<HLT::ErrorCode>(( chainWord >> (3+7+16)) & 0x0000003f);
  return HLT::OK;
}

setStatus()

void HLT::Chain::setStatus ( ChainStatus s )

inlineprotected

Definition at line 141 of file Chain.h.

{ m_status = s; }

Member Data Documentation

m_chain_counter

unsigned int HLT::Chain::m_chain_counter

protected

chain counter from configuration (copied here for speed)

Definition at line 144 of file Chain.h.

m_configChain

const TrigConf::HLTChain* HLT::Chain::m_configChain

protected

underlying Config Chain

Definition at line 143 of file Chain.h.

m_currentStep

int HLT::Chain::m_currentStep

protected

Current step of this chain.

Definition at line 150 of file Chain.h.

m_errorCode

ErrorCode HLT::Chain::m_errorCode

protected

most severe error code of execution

Definition at line 145 of file Chain.h.

m_passedRaw

bool HLT::Chain::m_passedRaw

protected

Definition at line 146 of file Chain.h.

m_passThrough

bool HLT::Chain::m_passThrough

protected

Flagged as "passedThrough" for this event ?

Definition at line 147 of file Chain.h.

m_prescaled

bool HLT::Chain::m_prescaled

protected

Flagged as "prescaled" for this event ?

Definition at line 148 of file Chain.h.

m_resurrected

bool HLT::Chain::m_resurrected

protected

flag to mar that chain was originally prescalled but is reexecuted

Definition at line 149 of file Chain.h.

m_status

ChainStatus HLT::Chain::m_status

private

Chain status, enum {ChainInvalid, ConfigOnlyChain, ChainOK }.

Definition at line 153 of file Chain.h.

---

The documentation for this class was generated from the following files:

• Chain.h
• Chain.cxx