L1Calo User Header class. More...

#include <L1CaloUserHeader.h>

Collaboration diagram for LVL1BS::L1CaloUserHeader:

Public Member Functions
	L1CaloUserHeader (uint32_t header=0xf0000001)
	Constructor - default just sets word ID and number of header words. More...

uint32_t	header () const
	Return packed header. More...

int	words () const
	Return number of header words (should be one) More...

int	jepCmm () const

int	cpCmm () const

int	jem () const

int	cpm () const

int	ppmLut () const

int	ppmFadc () const

int	lowerBound () const
	Return FADC lower bound. More...

void	setJepCmm (int offset)

void	setCpCmm (int offset)

void	setJem (int offset)

void	setCpm (int offset)

void	setPpmLut (int offset)

void	setPpmFadc (int offset)

void	setLowerBound (int bound)
	Set FADC lower bound. More...

void	setVersion (int minorVersion)
	Set version flag. More...

Static Public Member Functions
static bool	isValid (uint32_t word)
	Test for valid header word. More...

Private Attributes
uint32_t	m_header
	Packed Header. More...

bool	m_version2
	Version flag. More...

Static Private Attributes
static const int	s_wordIdBit = 28

static const int	s_jepCmmBit = 24

static const int	s_cpCmmBit = 20

static const int	s_jemBit = 16

static const int	s_cpmBit = 12

static const int	s_ppmLutBit = 8

static const int	s_ppmFadcBit = 4

static const int	s_lowerBoundBit = 20

static const int	s_ppmLutBitV2 = 9

static const int	s_ppmFadcBitV2 = 4

static const uint32_t	s_mask = 0xf
	Field mask. More...

static const uint32_t	s_lowerBoundMask = 0xff

static const uint32_t	s_ppmLutMaskV2 = 0x7

static const uint32_t	s_ppmFadcMaskV2 = 0x1f

static const int	s_version1 = 0x1001
	Version 1 minor format version number. More...

Detailed Description

L1Calo User Header class.

The User Header is the first word of the ROD data and contains Triggered slice offsets for all the sub-detector types.

Author: Peter Faulkner

Definition at line 20 of file L1CaloUserHeader.h.

Constructor & Destructor Documentation

◆ L1CaloUserHeader()

LVL1BS::L1CaloUserHeader::L1CaloUserHeader ( uint32_t header = 0xf0000001 )

Constructor - default just sets word ID and number of header words.

Definition at line 29 of file L1CaloUserHeader.cxx.

                                                   : m_header(header),
                                                       m_version2(true)
 {
 }

Member Function Documentation

◆ cpCmm()

int LVL1BS::L1CaloUserHeader::cpCmm ( ) const

inline

Definition at line 105 of file L1CaloUserHeader.h.

 {
   return (m_version2) ? (m_header >> s_cpmBit  ) & s_mask
                       : (m_header >> s_cpCmmBit) & s_mask;
 }

◆ cpm()

int LVL1BS::L1CaloUserHeader::cpm ( ) const

inline

Definition at line 116 of file L1CaloUserHeader.h.

 {
   return (m_header >> s_cpmBit) & s_mask;
 }

◆ header()

uint32_t LVL1BS::L1CaloUserHeader::header ( ) const

inline

Return packed header.

Definition at line 89 of file L1CaloUserHeader.h.

 {
   return m_header;
 }

◆ isValid()

bool LVL1BS::L1CaloUserHeader::isValid ( uint32_t word )

static

Test for valid header word.

Definition at line 36 of file L1CaloUserHeader.cxx.

 {
   return ((word >> s_wordIdBit) & s_mask) == s_mask;
 }

◆ jem()

int LVL1BS::L1CaloUserHeader::jem ( ) const

inline

Definition at line 111 of file L1CaloUserHeader.h.

 {
   return (m_header >> s_jemBit) & s_mask;
 }

◆ jepCmm()

int LVL1BS::L1CaloUserHeader::jepCmm ( ) const

inline

Definition at line 99 of file L1CaloUserHeader.h.

 {
   return (m_version2) ? (m_header >> s_jemBit   ) & s_mask
                       : (m_header >> s_jepCmmBit) & s_mask;
 }

◆ lowerBound()

int LVL1BS::L1CaloUserHeader::lowerBound ( ) const

inline

Return FADC lower bound.

Definition at line 133 of file L1CaloUserHeader.h.

 {
   return (m_version2) ? (m_header >> s_lowerBoundBit) & s_lowerBoundMask
                       : 0;
 }

◆ ppmFadc()

int LVL1BS::L1CaloUserHeader::ppmFadc ( ) const

inline

Definition at line 127 of file L1CaloUserHeader.h.

 {
   return (m_version2) ? (m_header >> s_ppmFadcBitV2) & s_ppmFadcMaskV2
                       : (m_header >> s_ppmFadcBit  ) & s_mask;
 }

◆ ppmLut()

int LVL1BS::L1CaloUserHeader::ppmLut ( ) const

inline

Definition at line 121 of file L1CaloUserHeader.h.

 {
   return (m_version2) ? (m_header >> s_ppmLutBitV2) & s_ppmLutMaskV2
                       : (m_header >> s_ppmLutBit  ) & s_mask;
 }

◆ setCpCmm()

void LVL1BS::L1CaloUserHeader::setCpCmm ( int offset )

inline

Definition at line 144 of file L1CaloUserHeader.h.

 {
   if (!m_version2) m_header |= (s_mask & offset) << s_cpCmmBit;
 }

◆ setCpm()

void LVL1BS::L1CaloUserHeader::setCpm ( int offset )

inline

Definition at line 154 of file L1CaloUserHeader.h.

 {
   m_header |= (s_mask & offset) << s_cpmBit;
 }

◆ setJem()

void LVL1BS::L1CaloUserHeader::setJem ( int offset )

inline

Definition at line 149 of file L1CaloUserHeader.h.

 {
   m_header |= (s_mask & offset) << s_jemBit;
 }

◆ setJepCmm()

void LVL1BS::L1CaloUserHeader::setJepCmm ( int offset )

inline

Definition at line 139 of file L1CaloUserHeader.h.

 {
   if (!m_version2) m_header |= (s_mask & offset) << s_jepCmmBit;
 }

◆ setLowerBound()

void LVL1BS::L1CaloUserHeader::setLowerBound ( int bound )

inline

Set FADC lower bound.

Definition at line 171 of file L1CaloUserHeader.h.

 {
   if (m_version2) m_header |= (s_lowerBoundMask & bound) << s_lowerBoundBit;
 }

◆ setPpmFadc()

void LVL1BS::L1CaloUserHeader::setPpmFadc ( int offset )

inline

Definition at line 165 of file L1CaloUserHeader.h.

 {
   m_header |= (m_version2) ? (s_ppmFadcMaskV2 & offset) << s_ppmFadcBitV2
                            : (s_mask          & offset) << s_ppmFadcBit;
 }

◆ setPpmLut()

void LVL1BS::L1CaloUserHeader::setPpmLut ( int offset )

inline

Definition at line 159 of file L1CaloUserHeader.h.

 {
   m_header |= (m_version2) ? (s_ppmLutMaskV2 & offset) << s_ppmLutBitV2
                            : (s_mask         & offset) << s_ppmLutBit;
 }

◆ setVersion()

void LVL1BS::L1CaloUserHeader::setVersion ( int minorVersion )

inline

Set version flag.

Definition at line 176 of file L1CaloUserHeader.h.

 {
   m_version2 = (minorVersion > s_version1);
 }

◆ words()

int LVL1BS::L1CaloUserHeader::words ( ) const

inline

Return number of header words (should be one)

Definition at line 94 of file L1CaloUserHeader.h.

 {
   return m_header & s_mask;
 }

Member Data Documentation

◆ m_header

uint32_t LVL1BS::L1CaloUserHeader::m_header

private

Packed Header.

Definition at line 83 of file L1CaloUserHeader.h.

◆ m_version2

bool LVL1BS::L1CaloUserHeader::m_version2

private

Version flag.

Definition at line 85 of file L1CaloUserHeader.h.

◆ s_cpCmmBit

const int LVL1BS::L1CaloUserHeader::s_cpCmmBit = 20

staticprivate

Definition at line 65 of file L1CaloUserHeader.h.

◆ s_cpmBit

const int LVL1BS::L1CaloUserHeader::s_cpmBit = 12

staticprivate

Definition at line 67 of file L1CaloUserHeader.h.

◆ s_jemBit

const int LVL1BS::L1CaloUserHeader::s_jemBit = 16

staticprivate

Definition at line 66 of file L1CaloUserHeader.h.

◆ s_jepCmmBit

const int LVL1BS::L1CaloUserHeader::s_jepCmmBit = 24

staticprivate

Definition at line 64 of file L1CaloUserHeader.h.

◆ s_lowerBoundBit

const int LVL1BS::L1CaloUserHeader::s_lowerBoundBit = 20

staticprivate

Definition at line 71 of file L1CaloUserHeader.h.

◆ s_lowerBoundMask

const uint32_t LVL1BS::L1CaloUserHeader::s_lowerBoundMask = 0xff

staticprivate

Definition at line 77 of file L1CaloUserHeader.h.

◆ s_mask

const uint32_t LVL1BS::L1CaloUserHeader::s_mask = 0xf

staticprivate

Field mask.

Definition at line 75 of file L1CaloUserHeader.h.

◆ s_ppmFadcBit

const int LVL1BS::L1CaloUserHeader::s_ppmFadcBit = 4

staticprivate

Definition at line 69 of file L1CaloUserHeader.h.

◆ s_ppmFadcBitV2

const int LVL1BS::L1CaloUserHeader::s_ppmFadcBitV2 = 4

staticprivate

Definition at line 73 of file L1CaloUserHeader.h.

◆ s_ppmFadcMaskV2

const uint32_t LVL1BS::L1CaloUserHeader::s_ppmFadcMaskV2 = 0x1f

staticprivate

Definition at line 79 of file L1CaloUserHeader.h.

◆ s_ppmLutBit

const int LVL1BS::L1CaloUserHeader::s_ppmLutBit = 8

staticprivate

Definition at line 68 of file L1CaloUserHeader.h.

◆ s_ppmLutBitV2

const int LVL1BS::L1CaloUserHeader::s_ppmLutBitV2 = 9

staticprivate

Definition at line 72 of file L1CaloUserHeader.h.

◆ s_ppmLutMaskV2

const uint32_t LVL1BS::L1CaloUserHeader::s_ppmLutMaskV2 = 0x7

staticprivate

Definition at line 78 of file L1CaloUserHeader.h.

◆ s_version1

const int LVL1BS::L1CaloUserHeader::s_version1 = 0x1001

staticprivate

Version 1 minor format version number.

Definition at line 81 of file L1CaloUserHeader.h.

◆ s_wordIdBit

const int LVL1BS::L1CaloUserHeader::s_wordIdBit = 28

staticprivate

Definition at line 63 of file L1CaloUserHeader.h.

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

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ L1CaloUserHeader()

Member Function Documentation

◆ cpCmm()

◆ cpm()

◆ header()

◆ isValid()

◆ jem()

◆ jepCmm()

◆ lowerBound()

◆ ppmFadc()

◆ ppmLut()

◆ setCpCmm()

◆ setCpm()

◆ setJem()

◆ setJepCmm()

◆ setLowerBound()

◆ setPpmFadc()

◆ setPpmLut()

◆ setVersion()

◆ words()

Member Data Documentation

◆ m_header

◆ m_version2

◆ s_cpCmmBit

◆ s_cpmBit

◆ s_jemBit

◆ s_jepCmmBit

◆ s_lowerBoundBit

◆ s_lowerBoundMask

◆ s_mask

◆ s_ppmFadcBit

◆ s_ppmFadcBitV2

◆ s_ppmFadcMaskV2

◆ s_ppmLutBit

◆ s_ppmLutBitV2

◆ s_ppmLutMaskV2

◆ s_version1

◆ s_wordIdBit