CMS 3D CMS Logo
List of all members | Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
L1GctProcessor Class Referenceabstract

ABC for a GCT trigger data processing unit. More...

#include <L1GctProcessor.h>

Inheritance diagram for L1GctProcessor:
L1GctElectronFinalSort L1GctElectronSorter L1GctEmLeafCard L1GctGlobalEnergyAlgos L1GctGlobalHfSumAlgos L1GctJetFinalStage L1GctJetFinderBase L1GctJetLeafCard L1GctWheelEnergyFpga L1GctWheelJetFpga

Classes

struct  Pipeline
 

Public Member Functions

virtual void fetchInput ()=0
 set the input buffers More...
 
 L1GctProcessor ()
 
virtual void process ()=0
 process the data and set outputs More...
 
void reset ()
 complete reset of processor More...
 
void setBxRange (const int firstBx, const int numberOfBx)
 define the bunch crossing range to process More...
 
void setNextBx (const int bxnum)
 clear input data buffers and process a new bunch crossing More...
 
void setTerse ()
 
bool setupOk () const
 Method to check the setup for this processor. Returns true by default. More...
 
void setVerbose ()
 control output messages More...
 
virtual ~L1GctProcessor ()
 

Protected Member Functions

int bxAbs () const
 
int bxMax () const
 
int bxMin () const
 Support for multiple beam crossing operation. More...
 
int bxRel () const
 
int numOfBx () const
 
virtual void resetPipelines ()=0
 
virtual void resetProcessor ()=0
 Separate reset methods for the processor itself and any data stored in pipelines. More...
 
virtual void setupObjects ()=0
 Initialise inputs with null objects for the correct bunch crossing if required. More...
 

Protected Attributes

bool m_verbose
 Flag to control output messages. More...
 

Private Attributes

int m_bx
 Support for multiple beam crossing operation. More...
 
int m_bxStart
 
int m_numOfBx
 

Detailed Description

ABC for a GCT trigger data processing unit.

Author
Jim Brooke
Date
April 2006

A processing unit can be a card, an FPGA, a chunk of firmware. This class exists simply to enforce a common interface.

There should not be any L1GctProcessor* pointers!

Definition at line 22 of file L1GctProcessor.h.

Constructor & Destructor Documentation

L1GctProcessor::L1GctProcessor ( )
inline

Definition at line 26 of file L1GctProcessor.h.

26 : m_verbose(false), m_bx(0), m_bxStart(0), m_numOfBx(1) {};
L1GctProcessor::m_verbose
bool m_verbose
Flag to control output messages.
Definition: L1GctProcessor.h:117
L1GctProcessor::m_bx
int m_bx
Support for multiple beam crossing operation.
Definition: L1GctProcessor.h:121
virtual L1GctProcessor::~L1GctProcessor ( )
inlinevirtual

Definition at line 27 of file L1GctProcessor.h.

27 {};

Member Function Documentation

int L1GctProcessor::bxAbs ( ) const
inlineprotected

Definition at line 83 of file L1GctProcessor.h.

References m_bx.

Referenced by L1GctJetFinalStage::setInputCentralJet(), L1GctElectronFinalSort::setInputEmCand(), L1GctJetFinalStage::setInputForwardJet(), L1GctJetFinalStage::setInputTauJet(), L1GctElectronSorter::setupObjects(), L1GctWheelJetFpga::setupObjects(), L1GctJetFinderBase::setupObjects(), and L1GctJetFinalStage::storeJets().

83 { return m_bx; }
L1GctProcessor::m_bx
int m_bx
Support for multiple beam crossing operation.
Definition: L1GctProcessor.h:121
int L1GctProcessor::bxMax ( ) const
inlineprotected

Definition at line 81 of file L1GctProcessor.h.

References m_bxStart, and m_numOfBx.

81 { return (m_bxStart + m_numOfBx - 1); }
int L1GctProcessor::bxMin ( ) const
inlineprotected

Support for multiple beam crossing operation.

Definition at line 80 of file L1GctProcessor.h.

References m_bxStart.

Referenced by L1GctWheelEnergyFpga::getInternalEtSums(), L1GctJetLeafCard::getInternalEtSums(), L1GctJetFinderBase::getInternalEtSums(), L1GctWheelJetFpga::getInternalHtMiss(), L1GctJetLeafCard::getInternalHtMiss(), L1GctJetFinderBase::getInternalHtMiss(), and operator<<().

80 { return m_bxStart; }
int L1GctProcessor::bxRel ( ) const
inlineprotected

Definition at line 84 of file L1GctProcessor.h.

References m_bx, and m_bxStart.

Referenced by L1GctJetFinderBase::doEtSums(), L1GctJetFinderBase::doHtSums(), L1GctJetFinalStage::process(), L1GctElectronFinalSort::process(), L1GctWheelEnergyFpga::process(), L1GctWheelJetFpga::process(), L1GctGlobalEnergyAlgos::process(), L1GctJetLeafCard::process(), L1GctJetFinderBase::sortJets(), L1GctGlobalHfSumAlgos::storeBitCount(), and L1GctGlobalHfSumAlgos::storeEtSum().

84 { return (m_bx - m_bxStart); }
L1GctProcessor::m_bx
int m_bx
Support for multiple beam crossing operation.
Definition: L1GctProcessor.h:121
virtual void L1GctProcessor::fetchInput ( )
pure virtual

set the input buffers

Implemented in L1GctJetFinderBase, L1GctJetLeafCard, L1GctTdrJetFinder, L1GctElectronSorter, L1GctGlobalEnergyAlgos, L1GctWheelJetFpga, L1GctWheelEnergyFpga, L1GctElectronFinalSort, L1GctGlobalHfSumAlgos, L1GctJetFinalStage, L1GctHardwareJetFinder, L1GctSimpleJetFinder, L1GctEmLeafCard, and L1GctNullJetFinder.

Referenced by reset().

int L1GctProcessor::numOfBx ( ) const
inlineprotected

Definition at line 82 of file L1GctProcessor.h.

References m_numOfBx.

Referenced by L1GctWheelEnergyFpga::getInternalEtSums(), L1GctJetLeafCard::getInternalEtSums(), L1GctJetFinderBase::getInternalEtSums(), L1GctWheelJetFpga::getInternalHtMiss(), L1GctJetLeafCard::getInternalHtMiss(), L1GctJetFinderBase::getInternalHtMiss(), L1GctGlobalHfSumAlgos::hfSumsOutput(), L1GctGlobalHfSumAlgos::hfSumsWord(), operator<<(), L1GctJetFinalStage::resetPipelines(), L1GctElectronFinalSort::resetPipelines(), L1GctGlobalHfSumAlgos::resetPipelines(), L1GctWheelEnergyFpga::resetPipelines(), L1GctWheelJetFpga::resetPipelines(), L1GctJetLeafCard::resetPipelines(), L1GctGlobalEnergyAlgos::resetPipelines(), and L1GctJetFinderBase::resetPipelines().

82 { return m_numOfBx; }
virtual void L1GctProcessor::process ( )
pure virtual

process the data and set outputs

Implemented in L1GctJetFinderBase, L1GctJetLeafCard, L1GctTdrJetFinder, L1GctElectronSorter, L1GctGlobalEnergyAlgos, L1GctWheelJetFpga, L1GctWheelEnergyFpga, L1GctElectronFinalSort, L1GctGlobalHfSumAlgos, L1GctJetFinalStage, L1GctHardwareJetFinder, L1GctSimpleJetFinder, L1GctEmLeafCard, and L1GctNullJetFinder.

Referenced by reset().

void L1GctProcessor::reset ( void  )
inline

complete reset of processor

Definition at line 30 of file L1GctProcessor.h.

References fetchInput(), m_bx, m_bxStart, m_numOfBx, process(), resetPipelines(), resetProcessor(), and setupObjects().

Referenced by L1GctJetFinderBase::L1GctJetFinderBase(), L1GctNullJetFinder::L1GctNullJetFinder(), L1GctTdrJetFinder::L1GctTdrJetFinder(), L1GctEmLeafCard::reset(), L1GctHardwareJetFinder::reset(), L1GctGlobalEnergyAlgos::reset(), L1GctJetLeafCard::reset(), and L1GlobalCaloTrigger::reset().

30  {
31  m_bxStart = 0;
32  m_numOfBx = 1;
33  m_bx = 0;
34  resetPipelines();
35  resetProcessor();
36  setupObjects();
37  }
L1GctProcessor::resetPipelines
virtual void resetPipelines()=0
L1GctProcessor::resetProcessor
virtual void resetProcessor()=0
Separate reset methods for the processor itself and any data stored in pipelines. ...
L1GctProcessor::setupObjects
virtual void setupObjects()=0
Initialise inputs with null objects for the correct bunch crossing if required.
L1GctProcessor::m_bx
int m_bx
Support for multiple beam crossing operation.
Definition: L1GctProcessor.h:121
virtual void L1GctProcessor::resetPipelines ( )
protectedpure virtual

Implemented in L1GctJetFinderBase, L1GctGlobalEnergyAlgos, L1GctJetLeafCard, L1GctWheelJetFpga, L1GctWheelEnergyFpga, L1GctElectronSorter, L1GctGlobalHfSumAlgos, L1GctElectronFinalSort, L1GctEmLeafCard, and L1GctJetFinalStage.

Referenced by reset(), setBxRange(), and setTerse().

virtual void L1GctProcessor::resetProcessor ( )
protectedpure virtual

Separate reset methods for the processor itself and any data stored in pipelines.

Implemented in L1GctJetFinderBase, L1GctGlobalEnergyAlgos, L1GctJetLeafCard, L1GctWheelJetFpga, L1GctWheelEnergyFpga, L1GctElectronSorter, L1GctGlobalHfSumAlgos, L1GctElectronFinalSort, L1GctEmLeafCard, and L1GctJetFinalStage.

Referenced by reset(), setNextBx(), and setTerse().

void L1GctProcessor::setBxRange ( const int  firstBx,
const int  numberOfBx 
)
inline

define the bunch crossing range to process

Definition at line 46 of file L1GctProcessor.h.

References m_bxStart, m_numOfBx, and resetPipelines().

Referenced by L1GlobalCaloTrigger::bxSetup(), L1GctEmLeafCard::setBxRange(), L1GctGlobalEnergyAlgos::setBxRange(), and L1GctJetLeafCard::setBxRange().

46  {
47  m_bxStart = firstBx;
48  m_numOfBx = numberOfBx;
49  resetPipelines();
50  }
L1GctProcessor::resetPipelines
virtual void resetPipelines()=0
void L1GctProcessor::setNextBx ( const int  bxnum)
inline

clear input data buffers and process a new bunch crossing

Definition at line 53 of file L1GctProcessor.h.

References m_bx, m_bxStart, m_numOfBx, resetProcessor(), and setupObjects().

Referenced by L1GlobalCaloTrigger::bxReset(), L1GctEmLeafCard::setNextBx(), L1GctGlobalEnergyAlgos::setNextBx(), and L1GctJetLeafCard::setNextBx().

53  {
54  if ( (bxnum-m_bxStart >= 0) && (bxnum-m_bxStart < m_numOfBx) ) {
55  m_bx = bxnum;
56  } else {
57  m_bx = 0;
58  }
59  resetProcessor();
60  setupObjects();
61  }
L1GctProcessor::resetProcessor
virtual void resetProcessor()=0
Separate reset methods for the processor itself and any data stored in pipelines. ...
L1GctProcessor::setupObjects
virtual void setupObjects()=0
Initialise inputs with null objects for the correct bunch crossing if required.
L1GctProcessor::m_bx
int m_bx
Support for multiple beam crossing operation.
Definition: L1GctProcessor.h:121
void L1GctProcessor::setTerse ( )
inline

Definition at line 68 of file L1GctProcessor.h.

References m_verbose, resetPipelines(), resetProcessor(), and setupObjects().

Referenced by L1GlobalCaloTrigger::setTerse().

68 { m_verbose = false; }
L1GctProcessor::m_verbose
bool m_verbose
Flag to control output messages.
Definition: L1GctProcessor.h:117
virtual void L1GctProcessor::setupObjects ( )
protectedpure virtual

Initialise inputs with null objects for the correct bunch crossing if required.

Implemented in L1GctJetFinderBase, L1GctGlobalEnergyAlgos, L1GctJetLeafCard, L1GctWheelJetFpga, L1GctWheelEnergyFpga, L1GctElectronSorter, L1GctGlobalHfSumAlgos, L1GctElectronFinalSort, L1GctEmLeafCard, and L1GctJetFinalStage.

Referenced by reset(), setNextBx(), and setTerse().

bool L1GctProcessor::setupOk ( ) const
inline

Method to check the setup for this processor. Returns true by default.

Definition at line 64 of file L1GctProcessor.h.

64 { return true; }
void L1GctProcessor::setVerbose ( )
inline

control output messages

Definition at line 67 of file L1GctProcessor.h.

References m_verbose.

Referenced by L1GlobalCaloTrigger::setVerbose().

67 { m_verbose = true; }
L1GctProcessor::m_verbose
bool m_verbose
Flag to control output messages.
Definition: L1GctProcessor.h:117

Member Data Documentation

int L1GctProcessor::m_bx
private

Support for multiple beam crossing operation.

Definition at line 121 of file L1GctProcessor.h.

Referenced by bxAbs(), bxRel(), reset(), and setNextBx().

int L1GctProcessor::m_bxStart
private

Definition at line 123 of file L1GctProcessor.h.

Referenced by bxMax(), bxMin(), bxRel(), reset(), setBxRange(), and setNextBx().

int L1GctProcessor::m_numOfBx
private

Definition at line 124 of file L1GctProcessor.h.

Referenced by bxMax(), numOfBx(), reset(), setBxRange(), and setNextBx().

bool L1GctProcessor::m_verbose
protected

Flag to control output messages.

Definition at line 117 of file L1GctProcessor.h.

Referenced by L1GctWheelJetFpga::checkSetup(), L1GctWheelJetFpga::classifyJets(), L1GctJetFinderBase::etComponentForJetFinder(), L1GctElectronFinalSort::L1GctElectronFinalSort(), L1GctGlobalEnergyAlgos::L1GctGlobalEnergyAlgos(), L1GctGlobalHfSumAlgos::L1GctGlobalHfSumAlgos(), L1GctJetFinalStage::L1GctJetFinalStage(), L1GctJetFinderBase::L1GctJetFinderBase(), L1GctJetLeafCard::L1GctJetLeafCard(), L1GctWheelEnergyFpga::L1GctWheelEnergyFpga(), L1GctWheelJetFpga::L1GctWheelJetFpga(), L1GctWheelJetFpga::setInputJet(), L1GctJetFinderBase::setNeighbourJetFinders(), L1GctJetLeafCard::setNeighbourLeafCards(), setTerse(), and setVerbose().

Generated for CMSSW Reference Manual by doxygen 1.8.11