L1CaloRdo Class Reference

Abstract base class for L1Calo "Raw Data Objects" (RDOs). More...

#include <L1CaloRdo.h>

Inheritance diagram for L1CaloRdo:

Collaboration diagram for L1CaloRdo:

Public Member Functions
virtual	~L1CaloRdo ()
int	getCrate () const
int	getModule () const
int	getEta () const
int	getPhi () const
int	getLayer () const
int	getValue (size_t slice) const
int	getValue () const
int	getFlag (size_t slice) const
int	getFlag () const
int	getL1aPos () const
L1CaloDetectorRegion	getRegion () const
const std::list< L1CaloRdoRodInfo >::const_iterator &	getRodInfo () const
int	getModuleStatus () const
bool	getModuleErrorGlinkParity () const
bool	getModuleErrorGlinkProtocol () const
bool	getModuleErrorBcnMismatch () const
bool	getModuleErrorFifoOverflow () const
bool	getModuleErrorSpecific () const
bool	getModuleErrorUnused () const
bool	getModuleErrorGlinkTimeout () const
bool	getModuleErrorGlinkDown () const
size_t	numSlices () const
bool	sameDatum (const L1CaloRdo &rhs) const
void	setValue (int val, size_t slice)
void	setValue (int val)
void	setFlag (int flag, size_t slice)
void	setFlag (int flag)
void	setRodInfo (std::list< L1CaloRdoRodInfo >::const_iterator &rodInfo)
void	info () const
virtual void	infoSpecific () const
virtual std::string	getType () const =0

Protected Member Functions
	L1CaloRdo (int crate, int module, int eta, int phi, int layer, int numSlices)
void	setRegion (const L1CaloDetectorRegion &region)

Private Member Functions
	L1CaloRdo ()

Private Attributes
int	m_crate
int	m_module
int	m_eta
int	m_phi
int	m_layer
std::vector< int >	m_vals
std::vector< int >	m_flags
int	m_l1aPos
L1CaloDetectorRegion	m_region
std::list< L1CaloRdoRodInfo >::const_iterator	m_rodInfo

Detailed Description

Abstract base class for L1Calo "Raw Data Objects" (RDOs).

Each RDO represents some information associated with an eta,phi,layer for the complete set of readout time slices (bunch crossings). Different coordinates imply different RDOs, but all timeslices for the same coordinate are always kept in the same RDO. For each RDO there is an integer value and flag per timeslice. What this means is up to the subclasses. The value may be an Et of towers or jet elements, threshold multiplicities or hit bits indicating which thresholds were passed. Sometimes the value is bit coded to pack two values into one word. The flags are generally error bits, but in some cases other values are bit packed into the flags. Where either field is bit packed the subclass should have specific methods to decode them.

Definition at line 16 of file L1CaloRdo.h.

Constructor & Destructor Documentation

~L1CaloRdo()

L1CaloRdo::~L1CaloRdo ( )

virtual

Definition at line 43 of file L1CaloRdo.cxx.

{
   // std::cout << "Object Deleted" << std::endl;
}

L1CaloRdo() [1/2]

L1CaloRdo::L1CaloRdo ( int crate, int module, int eta, int phi, int layer, int numSlices )

protected

Definition at line 26 of file L1CaloRdo.cxx.

: m_crate( crate )
, m_module( module )
, m_eta( eta )
, m_phi( phi )
, m_layer( layer )
, m_vals( numSlices, 0 )
, m_flags( numSlices, 0 )
, m_l1aPos( numSlices/2 )
#ifdef OFFLINE_DECODER
, m_word0s(numSlices,0),m_word1s(numSlices,0)
#endif
{
   // std::cout << "Object Created" << std::endl;
}

L1CaloRdo() [2/2]

L1CaloRdo::L1CaloRdo ( )

private

Member Function Documentation

getCrate()

int L1CaloRdo::getCrate

(

)

const

Definition at line 73 of file L1CaloRdo.cxx.

{
   return m_crate;
}

getEta()

int L1CaloRdo::getEta

(

)

const

Definition at line 85 of file L1CaloRdo.cxx.

{
   return m_eta;
}

getFlag() [1/2]

int L1CaloRdo::getFlag

(

)

const

Definition at line 125 of file L1CaloRdo.cxx.

{
   return getFlag( getL1aPos() );
}

getFlag() [2/2]

int L1CaloRdo::getFlag

(

size_t

slice

)

const

Definition at line 117 of file L1CaloRdo.cxx.

{
   if ( slice < m_flags.size() )
      return m_flags[slice];
   return 0;
}

getL1aPos()

int L1CaloRdo::getL1aPos

(

)

const

Definition at line 131 of file L1CaloRdo.cxx.

{
   return m_l1aPos;
}

getLayer()

int L1CaloRdo::getLayer

(

)

const

Definition at line 97 of file L1CaloRdo.cxx.

{
   return m_layer;
}

getModule()

int L1CaloRdo::getModule

(

)

const

Definition at line 79 of file L1CaloRdo.cxx.

{
   return m_module;
}

getModuleErrorBcnMismatch()

bool L1CaloRdo::getModuleErrorBcnMismatch

(

)

const

Definition at line 168 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x04 ;
}

getModuleErrorFifoOverflow()

bool L1CaloRdo::getModuleErrorFifoOverflow

(

)

const

Definition at line 174 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x08 ;
}

getModuleErrorGlinkDown()

bool L1CaloRdo::getModuleErrorGlinkDown

(

)

const

Definition at line 198 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x80 ;
}

getModuleErrorGlinkParity()

bool L1CaloRdo::getModuleErrorGlinkParity

(

)

const

Definition at line 156 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x01 ;
}

getModuleErrorGlinkProtocol()

bool L1CaloRdo::getModuleErrorGlinkProtocol

(

)

const

Definition at line 162 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x02 ;
}

getModuleErrorGlinkTimeout()

bool L1CaloRdo::getModuleErrorGlinkTimeout

(

)

const

Definition at line 192 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x40 ;
}

getModuleErrorSpecific()

bool L1CaloRdo::getModuleErrorSpecific

(

)

const

Definition at line 180 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x10 ;
}

getModuleErrorUnused()

bool L1CaloRdo::getModuleErrorUnused

(

)

const

Definition at line 186 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x20 ;
}

getModuleStatus()

int L1CaloRdo::getModuleStatus

(

)

const

Definition at line 150 of file L1CaloRdo.cxx.

{
   return m_rodInfo->getModuleStatus( getModule() );
}

getPhi()

int L1CaloRdo::getPhi

(

)

const

Definition at line 91 of file L1CaloRdo.cxx.

{
   return m_phi;
}

getRegion()

L1CaloDetectorRegion L1CaloRdo::getRegion

(

)

const

Definition at line 137 of file L1CaloRdo.cxx.

{
   return m_region;
}

getRodInfo()

const std::list< L1CaloRdoRodInfo >::const_iterator & L1CaloRdo::getRodInfo

(

)

const

Definition at line 144 of file L1CaloRdo.cxx.

{
   return m_rodInfo;
}

getType()

virtual std::string L1CaloRdo::getType ( ) const

pure virtual

Implemented in L1CaloRdoEfexTower, and L1CaloRdoFexTob.

getValue() [1/2]

int L1CaloRdo::getValue

(

)

const

Definition at line 111 of file L1CaloRdo.cxx.

{
   return getValue( getL1aPos() );
}

getValue() [2/2]

int L1CaloRdo::getValue

(

size_t

slice

)

const

Definition at line 103 of file L1CaloRdo.cxx.

{
   if ( slice < m_vals.size() )
      return m_vals[slice];
   return 0;
}

info()

void L1CaloRdo::info

(

)

const

Definition at line 258 of file L1CaloRdo.cxx.

{
   std::cout << "RDO Object Type: " << getType()
             << "  Crate: " << getCrate()
             << "  Module: " << getModule()
         << "  Eta: " << getEta()
         << "  Phi: " << getPhi()
         << "  Layer: " << getLayer() << std::endl;
   std::cout << "      Values:  " << std::hex;
   for ( size_t i = 0 ; i < m_vals.size() ; ++i )
      std::cout << getValue(i) << " ";
   std::cout << "      Flags:  ";
   for ( size_t i = 0 ; i < m_flags.size() ; ++i )
      std::cout << getFlag(i) << " ";
   std::cout << std::endl << std::dec;
   infoSpecific();
}

infoSpecific()

void L1CaloRdo::infoSpecific ( ) const

virtual

Reimplemented in L1CaloRdoEfexTob.

Definition at line 277 of file L1CaloRdo.cxx.

{
}

numSlices()

size_t L1CaloRdo::numSlices

(

)

const

Definition at line 204 of file L1CaloRdo.cxx.

{
   return m_vals.size();
}

sameDatum()

bool L1CaloRdo::sameDatum

(

const L1CaloRdo &

rhs

)

const

Definition at line 210 of file L1CaloRdo.cxx.

{
   if ( m_crate != rhs.m_crate )
      return false;
   if ( m_module != rhs.m_module )
      return false;
   if ( m_eta != rhs.m_eta )
      return false;
   if ( m_phi != rhs.m_phi )
      return false;
   if ( m_layer != rhs.m_layer )
      return false;
   return true;
}

setFlag() [1/2]

void L1CaloRdo::setFlag

(

int

flag

)

Definition at line 246 of file L1CaloRdo.cxx.

{
   setFlag( flag, getL1aPos() );
}

setFlag() [2/2]

void L1CaloRdo::setFlag	(	int	flag,
		size_t	slice )

Definition at line 239 of file L1CaloRdo.cxx.

{
   if ( slice < m_flags.size() )
      m_flags[slice] = flag;
}

setRegion()

void L1CaloRdo::setRegion ( const L1CaloDetectorRegion & region )

protected

Definition at line 283 of file L1CaloRdo.cxx.

{
   m_region = region;
}

setRodInfo()

void L1CaloRdo::setRodInfo

(

std::list< L1CaloRdoRodInfo >::const_iterator &

rodInfo

)

Definition at line 252 of file L1CaloRdo.cxx.

{
   m_rodInfo = rodInfo;
}

setValue() [1/2]

void L1CaloRdo::setValue

(

int

val

)

Definition at line 233 of file L1CaloRdo.cxx.

{
   setValue( val, getL1aPos() );
}

setValue() [2/2]

void L1CaloRdo::setValue	(	int	val,
		size_t	slice )

Definition at line 226 of file L1CaloRdo.cxx.

{
   if ( slice < m_vals.size() )
      m_vals[slice] = val;
}

Member Data Documentation

m_crate

int L1CaloRdo::m_crate

private

Definition at line 73 of file L1CaloRdo.h.

m_eta

int L1CaloRdo::m_eta

private

Definition at line 75 of file L1CaloRdo.h.

m_flags

std::vector<int> L1CaloRdo::m_flags

private

Definition at line 79 of file L1CaloRdo.h.

m_l1aPos

int L1CaloRdo::m_l1aPos

private

Definition at line 80 of file L1CaloRdo.h.

m_layer

int L1CaloRdo::m_layer

private

Definition at line 77 of file L1CaloRdo.h.

m_module

int L1CaloRdo::m_module

private

Definition at line 74 of file L1CaloRdo.h.

m_phi

int L1CaloRdo::m_phi

private

Definition at line 76 of file L1CaloRdo.h.

m_region

L1CaloDetectorRegion L1CaloRdo::m_region

private

Definition at line 82 of file L1CaloRdo.h.

m_rodInfo

std::list<L1CaloRdoRodInfo>::const_iterator L1CaloRdo::m_rodInfo

private

Definition at line 86 of file L1CaloRdo.h.

m_vals

std::vector<int> L1CaloRdo::m_vals

private

Definition at line 78 of file L1CaloRdo.h.

---

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

• L1CaloRdo.h
• L1CaloRdo.cxx