Sub-Block class for CMM-Jet data. More...

#include <CmmJetSubBlock.h>

Inheritance diagram for LVL1BS::CmmJetSubBlock:

Collaboration diagram for LVL1BS::CmmJetSubBlock:

Public Types
enum	SourceId { REMOTE_MAIN = 16, LOCAL_MAIN = 17, TOTAL_MAIN = 18, REMOTE_FORWARD = 20, LOCAL_FORWARD = 21, TOTAL_FORWARD = 22, MAX_SOURCE_ID }

enum	CmmFirmwareCode { CMM_CP = 0, CMM_JET = 1, CMM_ENERGY = 2, CMM_UNKNOWN = 3 }

enum	CmmSummingCode { CRATE = 0, SYSTEM = 1 }

enum	CmmPositions { LEFT = 0, RIGHT = 1 }

enum	SubBlockWordType { HEADER, DATA, STATUS }

enum	DataFormats { NEUTRAL = 0, UNCOMPRESSED = 1, COMPRESSED = 2, SUPERCOMPRESSED = 3 }

enum	DataErrorType { ERROR_NONE, ERROR_DUPLICATE_ROB, ERROR_ROD_ID, ERROR_ROD_NSTATUS, ERROR_USER_HEADER, ERROR_MISSING_HEADER, ERROR_MISSING_SUBBLOCK, ERROR_CRATE_NUMBER, ERROR_MODULE_NUMBER, ERROR_SLICES, ERROR_DUPLICATE_DATA, ERROR_ROI_TYPE, ERROR_MAX }

enum	UnpackErrorType { UNPACK_NONE = ERROR_NONE, UNPACK_VERSION = ERROR_MAX, UNPACK_FORMAT, UNPACK_COMPRESSION_VERSION, UNPACK_COMPRESSION_SLICES, UNPACK_DATA_TRUNCATED, UNPACK_EXCESS_DATA, UNPACK_SOURCE_ID, UNPACK_EXCESS_TOBS, UNPACK_DATA_ID }

Public Member Functions
	CmmJetSubBlock ()

	~CmmJetSubBlock ()

void	clear ()
	Clear all data. More...

unsigned int	jetHits (int slice, int source) const
	Return jet hit counts for given jem or source ID. More...

int	jetHitsError (int slice, int source) const
	Return jet hit error for given jem or source ID. More...

unsigned int	jetEtMap (int slice) const
	Return jet ET map. More...

void	setJetHits (int slice, int source, unsigned int hits, int error)
	Store jet hit counts and error for given jem or source ID. More...

void	setJetEtMap (int slice, unsigned int map)
	Store jet ET map. More...

bool	pack ()
	Pack data. More...

bool	unpack ()
	Unpack data. More...

void	setCmmHeader (int version, int format, int slice, int crate, int summing, int firmware, int position, int timeslices)
	Store CMM header. More...

int	cmmSumming () const

int	cmmFirmware () const

int	cmmPosition () const

int	timeslices () const

int	dataWords () const
	Return number of data words. More...

void	setHeader (int wordId, int version, int format, int seqno, int crate, int module, int slices2, int slices1)
	Store header data. More...

int	wordId () const

int	version () const

int	format () const

int	seqno () const

int	slice () const

int	crate () const

int	module () const

int	slices2 () const

int	slices1 () const

uint32_t	failingBCN () const

bool	glinkTimeout () const

bool	glinkDown () const

bool	upstreamError () const

bool	daqOverflow () const

bool	bcnMismatch () const

bool	glinkProtocol () const

bool	glinkParity () const

uint32_t	subStatus () const
	Return Sub-status word. More...

void	setBunchCrossing (int bc)
	Set the Bunch Crossing number (neutral format only) More...

int	bunchCrossing () const
	Return the Bunch Crossing number (neutral format only) More...

OFFLINE_FRAGMENTS_NAMESPACE::PointerType	read (const OFFLINE_FRAGMENTS_NAMESPACE::PointerType beg, const OFFLINE_FRAGMENTS_NAMESPACE::PointerType end)
	Input complete packed sub-block from ROD array. More...

void	write (FullEventAssembler< L1CaloSrcIdMap >::RODDATA *theROD) const
	Output complete packed sub-block to ROD vector. More...

void	setStatus (uint32_t failingBCN, bool glinkTimeout, bool glinkDown, bool upstreamError, bool daqOverflow, bool bcnMismatch, bool glinkProtocol, bool glinkParity)
	Store error status trailer. More...

void	setDaqOverflow (int bit=1)
	Set DAQ FIFO Overflow bit in Sub-status word. More...

void	setGlinkParity (int bit=1)
	Set G-Link Parity bit in Sub-status word. More...

void	setUnpackErrorCode (int code)
	Set the unpacking error code. More...

int	unpackErrorCode () const
	Return the unpacking error code. More...

std::string	unpackErrorMsg () const
	Return the unpacking error message for printing. More...

int	minBits (uint32_t datum) const
	Return the minimum number of bits needed for given data. More...

int	parityBit (int init, uint32_t datum, int nbits) const
	Return the parity bit for given data. More...

void	packer (uint32_t datum, int nbits)
	Pack given data into given number of bits. More...

void	packerFlush ()
	Flush the current data word padded with zeros. More...

void	setStreamed ()
	Set continuous bit streaming for compressed formats. More...

uint32_t	unpacker (int nbits)
	Unpack given number of bits of data. More...

uint32_t	unpacker (int nbits, int align)

void	unpackerInit ()
	Initialise unpacker. More...

bool	unpackerSuccess () const
	Return unpacker success flag. More...

void	packerNeutral (int pin, uint32_t datum, int nbits)
	Pack given neutral data from given pin. More...

void	packerNeutralParity (int pin)
	Pack current G-Link parity bit for given pin. More...

uint32_t	unpackerNeutral (int pin, int nbits)
	Unpack given number of bits of neutral data for given pin. More...

bool	unpackerNeutralParityError (int pin)
	Unpack and test G-Link parity bit for given pin. More...

int	currentPinBit (int pin) const
	Return current pin bit for given pin. More...

Static Public Member Functions
static CmmFirmwareCode	cmmType (uint32_t word)
	CMM differentiation (CMM_CP, CMM_JET, or CMM_ENERGY) More...

static bool	cmmBlock (uint32_t word)
	Determine if header word corresponds to CMM. More...

static int	wordId (uint32_t word)
	Return wordID field from given header word. More...

static int	version (uint32_t word)
	Return version number from given header word. More...

static int	format (uint32_t word)
	Return data format from given header word. More...

static int	seqno (uint32_t word)
	Return seqno field from given header word. More...

static int	module (uint32_t word)
	Return module field from given header word. More...

static SubBlockWordType	wordType (uint32_t word)
	Word identification. More...

Private Member Functions
int	sourceId (uint32_t word) const

int	index (int slice, int source) const

void	resize ()

bool	packNeutral ()
	Pack neutral data. More...

bool	packUncompressed ()
	Pack uncompressed data. More...

bool	unpackNeutral ()
	Unpack neutral data. More...

bool	unpackUncompressed ()
	Unpack uncompressed data. More...

Private Attributes
std::vector< uint32_t >	m_hitsData
	JEM hits and sums data. More...

uint32_t	m_header
	Sub-Block Header. More...

uint32_t	m_trailer
	Sub-Block Status Trailer. More...

int	m_bunchCrossing
	Bunch Crossing number (neutral format only) More...

int	m_unpackError
	Unpacking error code. More...

uint32_t	m_bitword

int	m_currentBit

int	m_maxBits

uint32_t	m_maxMask

bool	m_unpackerFlag

std::vector< uint32_t >::const_iterator	m_dataPos

std::vector< uint32_t >::const_iterator	m_dataPosEnd

std::vector< int >	m_currentPinBit

std::vector< int >	m_oddParity

int	m_dataWords
	Current number of data words. More...

std::vector< uint32_t >	m_data
	Sub-Block data. More...

std::vector< uint32_t >	m_unpackingMasks
	Unpacking masks. More...

Static Private Attributes
static const int	s_wordLength = 32
	Data word length. More...

static const int	s_threshBit = 0

static const int	s_fwdErrorBit = 16

static const int	s_etMapBit = 17

static const int	s_threshErrorBit = 24

static const int	s_sourceIdBit = 25

static const int	s_dataWordIdBit = 30

static const int	s_dataWordId = 0

static const int	s_maxHits = 23

static const uint32_t	s_threshMask = 0xffffff

static const uint32_t	s_fwdMask = 0xffff

static const uint32_t	s_etMapMask = 0xf

static const uint32_t	s_errorMask = 0x1

static const uint32_t	s_sourceIdMask = 0x1f

static const int	s_jetHitsBits = 24

static const int	s_jetHitsErrorBits = 1

static const int	s_fwdHitsBits = 16

static const int	s_bunchCrossingBits = 12

static const int	s_paddingBits = 8

static const int	s_rightBit = 8

static const int	s_fifoOverflowPin = 15

static const int	s_wordIdVal = 0xe
	CMM header word ID. More...

static const int	s_cmmSummingBit = 3

static const int	s_cmmFirmwareBit = 1

static const int	s_cmmPositionBit = 0

static const uint32_t	s_cmmSummingMask = 0x1

static const uint32_t	s_cmmFirmwareMask = 0x3

static const uint32_t	s_cmmPositionMask = 0x1

static const int	s_glinkBitsPerSlice = 35
	Needed for neutral format. More...

static const int	s_headerBit = 30

static const int	s_statusBit = 28

static const uint32_t	s_headerMask = 0x3

static const uint32_t	s_statusMask = 0x1

static const uint32_t	s_headerVal = 0x3

static const uint32_t	s_statusVal = 0x1

static const int	s_ppmCrates = 8

static const int	s_wordIdBit = 28

static const int	s_versionBit = 25

static const int	s_formatBit = 22

static const int	s_seqnoBit = 16

static const int	s_crateBit = 12

static const int	s_moduleBit = 8

static const int	s_slices2Bit = 3

static const int	s_slices1Bit = 0

static const uint32_t	s_wordIdMask = 0xf

static const uint32_t	s_versionMask = 0x7

static const uint32_t	s_formatMask = 0x7

static const uint32_t	s_seqnoMask = 0x3f

static const uint32_t	s_crateMask = 0xf

static const uint32_t	s_moduleMask = 0xf

static const uint32_t	s_slices2Mask = 0x1f

static const uint32_t	s_slices1Mask = 0x7

static const int	s_failingBcnBit = 22

static const int	s_glinkTimeoutBit = 7

static const int	s_glinkDownBit = 6

static const int	s_upstreamErrorBit = 4

static const int	s_daqOverflowBit = 3

static const int	s_bcnMismatchBit = 2

static const int	s_glinkProtocolBit = 1

static const int	s_glinkParityBit = 0

static const uint32_t	s_failingBcnMask = 0x3f

static const int	s_maxWordBits = 32

static const int	s_maxStreamedBits = 31

static const uint32_t	s_maxWordMask = 0xffffffff

static const uint32_t	s_maxStreamedMask = 0x7fffffff

static const int	s_maxPins = 20

static const uint32_t	s_glinkDavSet = 0x400000

Detailed Description

Sub-Block class for CMM-Jet data.

Based on "ATLAS Level-1 Calorimeter Trigger Read-out Driver" Version 1.06d

Author: Peter Faulkner

Definition at line 23 of file CmmJetSubBlock.h.

Member Enumeration Documentation

◆ CmmFirmwareCode

enum LVL1BS::CmmSubBlock::CmmFirmwareCode

inherited

Enumerator
CMM_CP
CMM_JET
CMM_ENERGY
CMM_UNKNOWN

Definition at line 25 of file CmmSubBlock.h.

25 { CMM_CP = 0, CMM_JET = 1, CMM_ENERGY = 2,

26 CMM_UNKNOWN = 3 };

◆ CmmPositions

enum LVL1BS::CmmSubBlock::CmmPositions

inherited

Enumerator
LEFT
RIGHT

Definition at line 28 of file CmmSubBlock.h.

28 { LEFT = 0, RIGHT = 1 };

◆ CmmSummingCode

enum LVL1BS::CmmSubBlock::CmmSummingCode

inherited

Enumerator
CRATE
SYSTEM

Definition at line 27 of file CmmSubBlock.h.

27 { CRATE = 0, SYSTEM = 1 };

◆ DataErrorType

enum LVL1BS::L1CaloSubBlock::DataErrorType

inherited

Enumerator
ERROR_NONE
ERROR_DUPLICATE_ROB
ERROR_ROD_ID
ERROR_ROD_NSTATUS
ERROR_USER_HEADER
ERROR_MISSING_HEADER
ERROR_MISSING_SUBBLOCK
ERROR_CRATE_NUMBER
ERROR_MODULE_NUMBER
ERROR_SLICES
ERROR_DUPLICATE_DATA
ERROR_ROI_TYPE
ERROR_MAX

Definition at line 31 of file L1CaloSubBlock.h.

                          { ERROR_NONE, ERROR_DUPLICATE_ROB, ERROR_ROD_ID,
                            ERROR_ROD_NSTATUS, ERROR_USER_HEADER,
                            ERROR_MISSING_HEADER, ERROR_MISSING_SUBBLOCK,
                ERROR_CRATE_NUMBER, ERROR_MODULE_NUMBER,
                ERROR_SLICES, ERROR_DUPLICATE_DATA,
                ERROR_ROI_TYPE, ERROR_MAX };

◆ DataFormats

enum LVL1BS::L1CaloSubBlock::DataFormats

inherited

Enumerator
NEUTRAL
UNCOMPRESSED
COMPRESSED
SUPERCOMPRESSED

Definition at line 28 of file L1CaloSubBlock.h.

28 { NEUTRAL = 0, UNCOMPRESSED = 1, COMPRESSED = 2,

29 SUPERCOMPRESSED = 3 };

◆ SourceId

enum LVL1BS::CmmJetSubBlock::SourceId

Enumerator
REMOTE_MAIN
LOCAL_MAIN
TOTAL_MAIN
REMOTE_FORWARD
LOCAL_FORWARD
TOTAL_FORWARD
MAX_SOURCE_ID

Definition at line 26 of file CmmJetSubBlock.h.

                  { REMOTE_MAIN = 16, LOCAL_MAIN = 17, TOTAL_MAIN = 18,
                  REMOTE_FORWARD = 20, LOCAL_FORWARD = 21, TOTAL_FORWARD = 22,
          MAX_SOURCE_ID };

◆ SubBlockWordType

enum LVL1BS::L1CaloSubBlock::SubBlockWordType

inherited

Enumerator
HEADER
DATA
STATUS

Definition at line 27 of file L1CaloSubBlock.h.

27 { HEADER, DATA, STATUS };

◆ UnpackErrorType

enum LVL1BS::L1CaloSubBlock::UnpackErrorType

inherited

Enumerator
UNPACK_NONE
UNPACK_VERSION
UNPACK_FORMAT
UNPACK_COMPRESSION_VERSION
UNPACK_COMPRESSION_SLICES
UNPACK_DATA_TRUNCATED
UNPACK_EXCESS_DATA
UNPACK_SOURCE_ID
UNPACK_EXCESS_TOBS
UNPACK_DATA_ID

Definition at line 38 of file L1CaloSubBlock.h.

                          { UNPACK_NONE = ERROR_NONE, UNPACK_VERSION = ERROR_MAX,
                            UNPACK_FORMAT, UNPACK_COMPRESSION_VERSION,
                UNPACK_COMPRESSION_SLICES, UNPACK_DATA_TRUNCATED,
                UNPACK_EXCESS_DATA, UNPACK_SOURCE_ID,
                UNPACK_EXCESS_TOBS, UNPACK_DATA_ID };

Constructor & Destructor Documentation

◆ CmmJetSubBlock()

LVL1BS::CmmJetSubBlock::CmmJetSubBlock ( )

Definition at line 37 of file CmmJetSubBlock.cxx.

38 {

39 }

◆ ~CmmJetSubBlock()

LVL1BS::CmmJetSubBlock::~CmmJetSubBlock ( )

Definition at line 41 of file CmmJetSubBlock.cxx.

42 {

43 }

Member Function Documentation

◆ bcnMismatch()

bool LVL1BS::L1CaloSubBlock::bcnMismatch ( ) const

inlineinherited

Definition at line 308 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_bcnMismatchBit);
 }

◆ bunchCrossing()

int LVL1BS::L1CaloSubBlock::bunchCrossing ( ) const

inlineinherited

Return the Bunch Crossing number (neutral format only)

Definition at line 333 of file L1CaloSubBlock.h.

 {
   return m_bunchCrossing;
 }

◆ clear()

void LVL1BS::CmmJetSubBlock::clear ( )

Clear all data.

Definition at line 47 of file CmmJetSubBlock.cxx.

 {
   L1CaloSubBlock::clear();
   m_hitsData.clear();
 }

◆ cmmBlock()

bool LVL1BS::CmmSubBlock::cmmBlock ( uint32_t word )

staticinherited

Determine if header word corresponds to CMM.

Definition at line 84 of file CmmSubBlock.cxx.

 {
   return L1CaloSubBlock::wordId(word) == s_wordIdVal;
 }

◆ cmmFirmware()

int LVL1BS::CmmSubBlock::cmmFirmware ( ) const

inlineinherited

Definition at line 68 of file CmmSubBlock.h.

 {
   return (module() >> s_cmmFirmwareBit) & s_cmmFirmwareMask;
 }

◆ cmmPosition()

int LVL1BS::CmmSubBlock::cmmPosition ( ) const

inlineinherited

Definition at line 73 of file CmmSubBlock.h.

 {
   return (module() >> s_cmmPositionBit) & s_cmmPositionMask;
 }

◆ cmmSumming()

int LVL1BS::CmmSubBlock::cmmSumming ( ) const

inlineinherited

Definition at line 63 of file CmmSubBlock.h.

 {
   return (module() >> s_cmmSummingBit) & s_cmmSummingMask;
 }

◆ cmmType()

CmmSubBlock::CmmFirmwareCode LVL1BS::CmmSubBlock::cmmType ( uint32_t word )

staticinherited

CMM differentiation (CMM_CP, CMM_JET, or CMM_ENERGY)

Definition at line 60 of file CmmSubBlock.cxx.

 {
   CmmFirmwareCode type;
   const int module = L1CaloSubBlock::module(word);
   const int code   = (module >> s_cmmFirmwareBit) & s_cmmFirmwareMask;
   switch (code) {
     case CMM_CP:
       type = CMM_CP;
       break;
     case CMM_JET:
       type = CMM_JET;
       break;
     case CMM_ENERGY:
       type = CMM_ENERGY;
       break;
     default:
       type = CMM_UNKNOWN;
       break;
   }
   return type;
 }

◆ crate()

int LVL1BS::L1CaloSubBlock::crate ( ) const

inlineinherited

Definition at line 263 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_crateBit) & s_crateMask;
 }

◆ currentPinBit()

int LVL1BS::L1CaloSubBlock::currentPinBit ( int pin ) const

inlineinherited

Return current pin bit for given pin.

Definition at line 359 of file L1CaloSubBlock.h.

 {
   return m_currentPinBit[pin];
 }

◆ daqOverflow()

bool LVL1BS::L1CaloSubBlock::daqOverflow ( ) const

inlineinherited

Definition at line 303 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_daqOverflowBit);
 }

◆ dataWords()

int LVL1BS::L1CaloSubBlock::dataWords ( ) const

inlineinherited

Return number of data words.

Definition at line 233 of file L1CaloSubBlock.h.

 {
   return m_dataWords;
 }

◆ failingBCN()

uint32_t LVL1BS::L1CaloSubBlock::failingBCN ( ) const

inlineinherited

Definition at line 283 of file L1CaloSubBlock.h.

 {
   return (m_trailer >> s_failingBcnBit) & s_failingBcnMask;
 }

◆ format() [1/2]

int LVL1BS::L1CaloSubBlock::format ( ) const

inlineinherited

Definition at line 248 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_formatBit) & s_formatMask;
 }

◆ format() [2/2]

int LVL1BS::L1CaloSubBlock::format ( uint32_t word )

staticinherited

Return data format from given header word.

Definition at line 506 of file L1CaloSubBlock.cxx.

 {
     return (word >> s_formatBit) & s_formatMask;
 }

◆ glinkDown()

bool LVL1BS::L1CaloSubBlock::glinkDown ( ) const

inlineinherited

Definition at line 293 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkDownBit);
 }

◆ glinkParity()

bool LVL1BS::L1CaloSubBlock::glinkParity ( ) const

inlineinherited

Definition at line 318 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkParityBit);
 }

◆ glinkProtocol()

bool LVL1BS::L1CaloSubBlock::glinkProtocol ( ) const

inlineinherited

Definition at line 313 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkProtocolBit);
 }

◆ glinkTimeout()

bool LVL1BS::L1CaloSubBlock::glinkTimeout ( ) const

inlineinherited

Definition at line 288 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_glinkTimeoutBit);
 }

◆ index()

int LVL1BS::CmmJetSubBlock::index	(	int	slice,
		int	source
	)		const

private

Definition at line 183 of file CmmJetSubBlock.cxx.

 {
   int ix = source;
   if (format() == NEUTRAL) ix += slice * s_maxHits;
   return ix;
 }

◆ jetEtMap()

unsigned int LVL1BS::CmmJetSubBlock::jetEtMap ( int slice ) const

Return jet ET map.

Definition at line 88 of file CmmJetSubBlock.cxx.

 {
   unsigned int map = 0;
   if (slice >= 0 && slice < timeslices() && !m_hitsData.empty()) {
     map = (m_hitsData[index(slice, TOTAL_FORWARD)] >> s_etMapBit) & s_etMapMask;
   }
   return map;
 }

◆ jetHits()

unsigned int LVL1BS::CmmJetSubBlock::jetHits	(	int	slice,
		int	source
	)		const

Return jet hit counts for given jem or source ID.

Definition at line 55 of file CmmJetSubBlock.cxx.

 {
   unsigned int hits = 0;
   if (slice >= 0 && slice < timeslices() &&
       source >= 0 && source < s_maxHits  && !m_hitsData.empty()) {
     if (source <= TOTAL_MAIN) {
       hits = (m_hitsData[index(slice, source)] >> s_threshBit) & s_threshMask;
     } else if (source >= REMOTE_FORWARD) {
       hits = (m_hitsData[index(slice, source)] >> s_threshBit) & s_fwdMask;
     }
   }
   return hits;
 }

◆ jetHitsError()

int LVL1BS::CmmJetSubBlock::jetHitsError	(	int	slice,
		int	source
	)		const

Return jet hit error for given jem or source ID.

Definition at line 71 of file CmmJetSubBlock.cxx.

 {
   int error = 0;
   if (slice >= 0 && slice < timeslices() &&
       source >= 0 && source < s_maxHits  && !m_hitsData.empty()) {
     if (source <= TOTAL_MAIN) {
       error = (m_hitsData[index(slice, source)] >> s_threshErrorBit)
                                                                   & s_errorMask;
     } else if (source == REMOTE_FORWARD) {
       error = (m_hitsData[index(slice, source)] >> s_fwdErrorBit) & s_errorMask;
     }
   }
   return error;
 }

◆ minBits()

int LVL1BS::L1CaloSubBlock::minBits ( uint32_t datum ) const

inherited

Return the minimum number of bits needed for given data.

Definition at line 274 of file L1CaloSubBlock.cxx.

 {
     const int maxBits = 32;
     int nbits = maxBits;
     for (int i = 0; i < maxBits; ++i)
     {
         if ( !(datum >> i))
         {
             nbits = i;
             break;
         }
     }
     return nbits;
 }

◆ module() [1/2]

int LVL1BS::L1CaloSubBlock::module ( ) const

inlineinherited

Definition at line 268 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_moduleBit) & s_moduleMask;
 }

◆ module() [2/2]

int LVL1BS::L1CaloSubBlock::module ( uint32_t word )

staticinherited

Return module field from given header word.

Definition at line 520 of file L1CaloSubBlock.cxx.

 {
     return (word >> s_moduleBit) & s_moduleMask;
 }

◆ pack()

bool LVL1BS::CmmJetSubBlock::pack ( )

Pack data.

Definition at line 135 of file CmmJetSubBlock.cxx.

 {
   bool rc = false;
   switch (version()) {
     case 1:
       switch (format()) {
         case NEUTRAL:
       rc = packNeutral();
       break;
         case UNCOMPRESSED:
       rc = packUncompressed();
       break;
         default:
       break;
       }
       break;
     default:
       break;
   }
   return rc;
 }

◆ packer()

void LVL1BS::L1CaloSubBlock::packer	(	uint32_t	datum,
		int	nbits
	)

inherited

Pack given data into given number of bits.

Definition at line 302 of file L1CaloSubBlock.cxx.

 {
     if (nbits > 0)
     {
         uint32_t mask = m_unpackingMasks[nbits];
         m_bitword |= (datum & mask) << m_currentBit;
         m_currentBit += nbits;
         if (m_currentBit >= m_maxBits)
         {
             m_bitword &= m_maxMask;
             m_data.push_back(m_bitword);
             ++m_dataWords;
             const int bitsLeft = m_currentBit - m_maxBits;
             if (bitsLeft > 0)
             {
                 m_bitword = (datum & mask) >> (nbits - bitsLeft);
                 m_currentBit = bitsLeft;
             }
             else
             {
                 m_bitword = 0;
                 m_currentBit = 0;
             }
         }
     }
 }

◆ packerFlush()

void LVL1BS::L1CaloSubBlock::packerFlush ( )

inherited

Flush the current data word padded with zeros.

Definition at line 331 of file L1CaloSubBlock.cxx.

 {
     if (m_currentBit > 0)
     {
         m_bitword &= m_maxMask;
         m_data.push_back(m_bitword);
         ++m_dataWords;
         m_bitword = 0;
         m_currentBit = 0;
     }
 }

◆ packerNeutral()

void LVL1BS::L1CaloSubBlock::packerNeutral	(	int	pin,
		uint32_t	datum,
		int	nbits
	)

inherited

Pack given neutral data from given pin.

Definition at line 413 of file L1CaloSubBlock.cxx.

 {
     if (pin >= 0 && pin < s_maxPins && nbits > 0)
     {
         if (m_currentPinBit[pin] + nbits > m_dataWords)
         {
             m_dataWords = m_currentPinBit[pin] + nbits;
             m_data.resize(m_dataWords, s_glinkDavSet);
         }
         for (int bit = 0; bit < nbits; ++bit)
         {
             m_data[m_currentPinBit[pin] + bit] |= ((datum >> bit) & 0x1) << pin;
         }
         m_currentPinBit[pin] += nbits;
         m_oddParity[pin] = parityBit(m_oddParity[pin], datum, nbits);
     }
 }

◆ packerNeutralParity()

void LVL1BS::L1CaloSubBlock::packerNeutralParity ( int pin )

inherited

Pack current G-Link parity bit for given pin.

Definition at line 434 of file L1CaloSubBlock.cxx.

 {
     if (pin >= 0 && pin < s_maxPins)
     {
         packerNeutral(pin, m_oddParity[pin], 1);
         m_oddParity[pin] = 1;
     }
 }

◆ packNeutral()

bool LVL1BS::CmmJetSubBlock::packNeutral ( )

private

Pack neutral data.

Definition at line 203 of file CmmJetSubBlock.cxx.

 {
   resize();
   const int slices = timeslices();
   for (int slice = 0; slice < slices; ++slice) {
     for (int pin = 0; pin <= TOTAL_MAIN; ++pin) {
       // Jem hits; remote, local and total main hits; parity error
       packerNeutral(pin, jetHits(slice, pin), s_jetHitsBits);
       packerNeutral(pin, jetHitsError(slice, pin), s_jetHitsErrorBits);
       // Bunch crossing number; Fifo overflow
       if (pin < s_bunchCrossingBits) {
         packerNeutral(pin, bunchCrossing() >> pin, 1);
       } else if (pin == s_fifoOverflowPin) {
         packerNeutral(pin, daqOverflow(), 1);
       } else packerNeutral(pin, 0, 1);
       // Padding
       if (pin < REMOTE_MAIN) packerNeutral(pin, 0, s_paddingBits);
     }
     // ET Map + padding
     packerNeutral(REMOTE_MAIN, jetEtMap(slice), s_paddingBits);
     // Total forward (left + right)
     packerNeutral(LOCAL_MAIN, jetHits(slice, TOTAL_FORWARD), s_paddingBits);
     packerNeutral(TOTAL_MAIN, jetHits(slice, TOTAL_FORWARD) >> s_rightBit,
                                                              s_paddingBits);
     // Remote + Local forward
     const int lastpin = TOTAL_MAIN + 1;
     packerNeutral(lastpin, jetHits(slice, REMOTE_FORWARD), s_fwdHitsBits);
     packerNeutral(lastpin, jetHitsError(slice, REMOTE_FORWARD),
                                                       s_jetHitsErrorBits);
     packerNeutral(lastpin, 0, 1);
     packerNeutral(lastpin, jetHits(slice, LOCAL_FORWARD),  s_fwdHitsBits);
     // G-Link parity
     for (int pin = 0; pin <= lastpin; ++pin) packerNeutralParity(pin);
   }
   return true;
 }

◆ packUncompressed()

bool LVL1BS::CmmJetSubBlock::packUncompressed ( )

private

Pack uncompressed data.

Definition at line 242 of file CmmJetSubBlock.cxx.

 {
   std::vector<uint32_t>::const_iterator pos;
   for (pos = m_hitsData.begin(); pos != m_hitsData.end(); ++pos) {
     if (*pos) packer(*pos, s_wordLength);
   }
   packerFlush();
   return true;
 }

◆ parityBit()

int LVL1BS::L1CaloSubBlock::parityBit	(	int	init,
		uint32_t	datum,
		int	nbits
	)		const

inherited

Return the parity bit for given data.

Definition at line 291 of file L1CaloSubBlock.cxx.

 {
     // set init to 0/1 for even/odd parity
     int parity = init;
     for (int bit = 0; bit < nbits; ++bit) parity ^= (datum >> bit) & 0x1;
     return parity;
 }

◆ read()

OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::L1CaloSubBlock::read	(	const OFFLINE_FRAGMENTS_NAMESPACE::PointerType	beg,
		const OFFLINE_FRAGMENTS_NAMESPACE::PointerType	end
	)

inherited

Input complete packed sub-block from ROD array.

Definition at line 118 of file L1CaloSubBlock.cxx.

 {
     m_dataWords = 0;
     m_unpackerFlag = true;
     OFFLINE_FRAGMENTS_NAMESPACE::PointerType pos(beg);
     OFFLINE_FRAGMENTS_NAMESPACE::PointerType pose(end);
     for (; pos != pose; ++pos)
     {
         const uint32_t word = *pos;
         const SubBlockWordType type = wordType(word);
         if (type == HEADER)
         {
             if (m_header) return pos;
             m_header = word;
         }
         else if (type == STATUS)
         {
             // Word ID should be consistent with header
             if (m_trailer || (wordId(word) != wordId() + 1)) return pos;
             m_trailer = word;
         }
         else
         {
             // Check data word IDs
             const int id = wordId(word);
             bool badId = false;
             // All neutral format '0000'
             if (format() == NEUTRAL)        badId = (id != 0);
             // Other PPM '0xxx'
             else if (crate() < s_ppmCrates) badId = ((id & 0x8) != 0);
             // Other CPM/JEM '01xx' or '10xx'
             else if (wordId() == 0xc)       badId = (((id & 0xc) != 0x4) &&
                                                         ((id & 0xc) != 0x8));
             // Other CMM/CMX '00xx'
             else                            badId = ((id & 0xc) != 0);
             if (m_trailer || badId) return pos;
             m_data.push_back(word);
             ++m_dataWords;
         }
     }
     return pose;
 }

◆ resize()

void LVL1BS::CmmJetSubBlock::resize ( )

private

Definition at line 192 of file CmmJetSubBlock.cxx.

 {
   if (m_hitsData.empty()) {
     int size = s_maxHits;
     if (format() == NEUTRAL) size *= timeslices();
     m_hitsData.resize(size);
   }
 }

◆ seqno() [1/2]

int LVL1BS::L1CaloSubBlock::seqno ( ) const

inlineinherited

Definition at line 253 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_seqnoBit) & s_seqnoMask;
 }

◆ seqno() [2/2]

int LVL1BS::L1CaloSubBlock::seqno ( uint32_t word )

staticinherited

Return seqno field from given header word.

Definition at line 513 of file L1CaloSubBlock.cxx.

 {
     return (word >> s_seqnoBit) & s_seqnoMask;
 }

◆ setBunchCrossing()

void LVL1BS::L1CaloSubBlock::setBunchCrossing ( int bc )

inlineinherited

Set the Bunch Crossing number (neutral format only)

Definition at line 328 of file L1CaloSubBlock.h.

 {
   if (bc) m_bunchCrossing = bc;
 }

◆ setCmmHeader()

void LVL1BS::CmmSubBlock::setCmmHeader	(	int	version,
		int	format,
		int	slice,
		int	crate,
		int	summing,
		int	firmware,
		int	position,
		int	timeslices
	)

inherited

Store CMM header.

Definition at line 33 of file CmmSubBlock.cxx.

 {
   int module = 0;
   module |= (summing  & s_cmmSummingMask)  << s_cmmSummingBit;
   module |= (firmware & s_cmmFirmwareMask) << s_cmmFirmwareBit;
   module |= (position & s_cmmPositionMask) << s_cmmPositionBit;
   setHeader(s_wordIdVal, version, format, slice, crate, module, 0,
                                                            timeslices);
 }

◆ setDaqOverflow()

void LVL1BS::L1CaloSubBlock::setDaqOverflow ( int bit = 1 )

inherited

Set DAQ FIFO Overflow bit in Sub-status word.

Definition at line 206 of file L1CaloSubBlock.cxx.

 {
     if (bit)
     {
         if (m_trailer) m_trailer |= (1 << s_daqOverflowBit);
         else setStatus(0, false, false, false, true, false, false, false);
     }
 }

◆ setGlinkParity()

void LVL1BS::L1CaloSubBlock::setGlinkParity ( int bit = 1 )

inherited

Set G-Link Parity bit in Sub-status word.

Definition at line 217 of file L1CaloSubBlock.cxx.

 {
     if (bit)
     {
         if (m_trailer) m_trailer |= (1 << s_glinkParityBit);
         else setStatus(0, false, false, false, false, false, false, true);
     }
 }

◆ setHeader()

void LVL1BS::L1CaloSubBlock::setHeader	(	int	wordId,
		int	version,
		int	format,
		int	seqno,
		int	crate,
		int	module,
		int	slices2,
		int	slices1
	)

inherited

Store header data.

Definition at line 99 of file L1CaloSubBlock.cxx.

 {
     uint32_t word = 0;
     word |= (wordId  & s_wordIdMask)  << s_wordIdBit;
     word |= (version & s_versionMask) << s_versionBit;
     word |= (format  & s_formatMask)  << s_formatBit;
     word |= (seqno   & s_seqnoMask)   << s_seqnoBit;
     word |= (crate   & s_crateMask)   << s_crateBit;
     word |= (module  & s_moduleMask)  << s_moduleBit;
     word |= (slices2 & s_slices2Mask) << s_slices2Bit;
     word |= (slices1 & s_slices1Mask) << s_slices1Bit;
     m_header = word;
 }

◆ setJetEtMap()

void LVL1BS::CmmJetSubBlock::setJetEtMap	(	int	slice,
		unsigned int	map
	)

Store jet ET map.

Definition at line 121 of file CmmJetSubBlock.cxx.

 {
   if (slice >= 0 && slice < timeslices() && map) {
     resize();
     uint32_t word = m_hitsData[index(slice, TOTAL_FORWARD)];
     word |= (map & s_etMapMask)              << s_etMapBit;
     word |= (TOTAL_FORWARD & s_sourceIdMask) << s_sourceIdBit;
     word |= (s_dataWordId)                   << s_dataWordIdBit;
     m_hitsData[index(slice, TOTAL_FORWARD)] = word;
   }
 }

◆ setJetHits()

void LVL1BS::CmmJetSubBlock::setJetHits	(	int	slice,
		int	source,
		unsigned int	hits,
		int	error
	)

Store jet hit counts and error for given jem or source ID.

Definition at line 99 of file CmmJetSubBlock.cxx.

 {
   if (slice >= 0 && slice < timeslices() &&
       source >= 0 && source < s_maxHits  && (hits || error)) {
     resize();
     uint32_t word = m_hitsData[index(slice, source)];
     if (source <= TOTAL_MAIN) {
       word |= (hits & s_threshMask)     << s_threshBit;
       word |= (error & s_errorMask)     << s_threshErrorBit;
     } else {
       word |= (hits & s_fwdMask)        << s_threshBit;
       word |= (error & s_errorMask)     << s_fwdErrorBit;
     }
     word   |= (source & s_sourceIdMask) << s_sourceIdBit;
     word   |= (s_dataWordId)            << s_dataWordIdBit;
     m_hitsData[index(slice, source)] = word;
   }
 }

◆ setStatus()

void LVL1BS::L1CaloSubBlock::setStatus	(	uint32_t	failingBCN,
		bool	glinkTimeout,
		bool	glinkDown,
		bool	upstreamError,
		bool	daqOverflow,
		bool	bcnMismatch,
		bool	glinkProtocol,
		bool	glinkParity
	)

inherited

Store error status trailer.

Definition at line 179 of file L1CaloSubBlock.cxx.

 {
     uint32_t word = 0;
     word |= (failingBCN & s_failingBcnMask) << s_failingBcnBit;
     word |= glinkTimeout  << s_glinkTimeoutBit;
     word |= glinkDown     << s_glinkDownBit;
     word |= upstreamError << s_upstreamErrorBit;
     word |= daqOverflow   << s_daqOverflowBit;
     word |= bcnMismatch   << s_bcnMismatchBit;
     word |= glinkProtocol << s_glinkProtocolBit;
     word |= glinkParity   << s_glinkParityBit;
     if (word)
     {
         word |= (wordId()    & s_wordIdMask) << s_wordIdBit;
         word |= (s_statusVal & s_statusMask) << s_statusBit;
         word |= (seqno()     & s_seqnoMask)  << s_seqnoBit;
         word |= (crate()     & s_crateMask)  << s_crateBit;
         word |= (module()    & s_moduleMask) << s_moduleBit;
     }
     m_trailer = word;
 }

◆ setStreamed()

void LVL1BS::L1CaloSubBlock::setStreamed ( )

inlineinherited

Set continuous bit streaming for compressed formats.

Definition at line 348 of file L1CaloSubBlock.h.

 {
   m_maxBits = s_maxStreamedBits;
   m_maxMask = s_maxStreamedMask;
 }

◆ setUnpackErrorCode()

void LVL1BS::L1CaloSubBlock::setUnpackErrorCode ( int code )

inlineinherited

Set the unpacking error code.

Definition at line 338 of file L1CaloSubBlock.h.

 {
   m_unpackError = code;
 }

◆ slice()

int LVL1BS::L1CaloSubBlock::slice ( ) const

inlineinherited

Definition at line 258 of file L1CaloSubBlock.h.

 {
   return seqno();
 }

◆ slices1()

int LVL1BS::L1CaloSubBlock::slices1 ( ) const

inlineinherited

Definition at line 278 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_slices1Bit) & s_slices1Mask;
 }

◆ slices2()

int LVL1BS::L1CaloSubBlock::slices2 ( ) const

inlineinherited

Definition at line 273 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_slices2Bit) & s_slices2Mask;
 }

◆ sourceId()

int LVL1BS::CmmJetSubBlock::sourceId ( uint32_t word ) const

inlineprivate

Definition at line 98 of file CmmJetSubBlock.h.

 {
   return (word >> s_sourceIdBit) & s_sourceIdMask;
 }

◆ subStatus()

uint32_t LVL1BS::L1CaloSubBlock::subStatus ( ) const

inlineinherited

Return Sub-status word.

Definition at line 323 of file L1CaloSubBlock.h.

 {
   return m_trailer;
 }

◆ timeslices()

int LVL1BS::CmmSubBlock::timeslices ( ) const

inherited

Definition at line 48 of file CmmSubBlock.cxx.

 {
   int slices = slices1();
   if (slices == 0 && format() == NEUTRAL) {
     slices = dataWords() / s_glinkBitsPerSlice;
   }
   if (slices == 0) slices = 1;
   return slices;
 }

◆ unpack()

bool LVL1BS::CmmJetSubBlock::unpack ( )

Unpack data.

Definition at line 157 of file CmmJetSubBlock.cxx.

 {
   bool rc = false;
   switch (version()) {
     case 1:
       switch (format()) {
         case NEUTRAL:
       rc = unpackNeutral();
       break;
         case UNCOMPRESSED:
       rc = unpackUncompressed();
       break;
         default:
       setUnpackErrorCode(UNPACK_FORMAT);
       break;
       }
       break;
     default:
       setUnpackErrorCode(UNPACK_VERSION);
       break;
   }
   return rc;
 }

◆ unpacker() [1/2]

uint32_t LVL1BS::L1CaloSubBlock::unpacker ( int nbits )

inherited

Unpack given number of bits of data.

Definition at line 345 of file L1CaloSubBlock.cxx.

 {
     uint32_t word = 0;
     if (nbits > 0)
     {
         if (m_dataPos == m_dataPosEnd)
         {
             m_unpackerFlag = false;
             return 0;
         }
         int nbitsDone = nbits;
         if (nbitsDone > m_maxBits - m_currentBit)
         {
             nbitsDone = m_maxBits - m_currentBit;
         }
         word = (m_bitword >> m_currentBit) & m_unpackingMasks[nbitsDone];
         m_currentBit += nbits;
         
         if (m_currentBit >= m_maxBits)
         {
             m_bitword = 0;
             if (m_dataPos != m_dataPosEnd)
             {
                 ++m_dataPos;
                 if (m_dataPos != m_dataPosEnd)
                 {
                     m_bitword = *m_dataPos;
                 }
             }
             m_currentBit = 0;
             const int bitsLeft = nbits - nbitsDone;
             if (bitsLeft > 0)
             {
                 if (m_dataPos == m_dataPosEnd)
                 {
                     m_unpackerFlag = false;
                     return word;
                 }
                 word |= (m_bitword & m_unpackingMasks[bitsLeft]) << nbitsDone;
                 m_currentBit = bitsLeft;
             }
         }
     }  
     return word;
 }

◆ unpacker() [2/2]

uint32_t LVL1BS::L1CaloSubBlock::unpacker	(	int	nbits,
		int	align
	)

inherited

◆ unpackerInit()

void LVL1BS::L1CaloSubBlock::unpackerInit ( )

inherited

Initialise unpacker.

Definition at line 393 of file L1CaloSubBlock.cxx.

 {
     m_bitword = 0;
     m_currentBit = 0;
     m_unpackerFlag = true;
     m_dataPos = m_data.begin();
     m_dataPosEnd = m_data.end();
     // std::cout << "SASHA4 m_dataPosEnd - m_dataPos=" << (m_dataPosEnd - m_dataPos) << std::endl;
     // uint16_t a = (*m_dataPos) & 0xFF;
     // uint16_t b = (*m_dataPos >> 11) & 0xFF;
     
     // std::cout << "SASHA5 first " << a << std::endl;
     // std::cout << "SASHA5 second " << b << std::endl;
     // std::cout << "SASHA5 datawords " << m_data.size() << std::endl;
  
     if (m_dataPos != m_dataPosEnd) m_bitword = *m_dataPos;
 }

◆ unpackerNeutral()

uint32_t LVL1BS::L1CaloSubBlock::unpackerNeutral	(	int	pin,
		int	nbits
	)

inherited

Unpack given number of bits of neutral data for given pin.

Definition at line 445 of file L1CaloSubBlock.cxx.

 {
     uint32_t word = 0;
     if (pin >= 0 && pin < s_maxPins && nbits > 0
             && m_currentPinBit[pin] + nbits <= m_dataWords)
     {
         for (int bit = 0; bit < nbits; ++bit)
         {
             word |= ((m_data[m_currentPinBit[pin] + bit] >> pin) & 0x1) << bit;
         }
         m_currentPinBit[pin] += nbits;
         m_oddParity[pin] = parityBit(m_oddParity[pin], word, nbits);
     }
     else m_unpackerFlag = false;
     return word;
 }

◆ unpackerNeutralParityError()

bool LVL1BS::L1CaloSubBlock::unpackerNeutralParityError ( int pin )

inherited

Unpack and test G-Link parity bit for given pin.

Definition at line 464 of file L1CaloSubBlock.cxx.

 {
     bool error = true;
     if (pin >= 0 && pin < s_maxPins)
     {
         int parity = m_oddParity[pin];
         int bit    = unpackerNeutral(pin, 1);
         m_oddParity[pin] = 1;
         error = !(bit == parity);
     }
     return error;
 }

◆ unpackErrorCode()

int LVL1BS::L1CaloSubBlock::unpackErrorCode ( ) const

inlineinherited

Return the unpacking error code.

Definition at line 343 of file L1CaloSubBlock.h.

 {
   return m_unpackError;
 }

◆ unpackErrorMsg()

std::string LVL1BS::L1CaloSubBlock::unpackErrorMsg ( ) const

inherited

Return the unpacking error message for printing.

Definition at line 228 of file L1CaloSubBlock.cxx.

 {
     std::string msg;
     switch (m_unpackError)
     {
     case UNPACK_NONE:
         msg = "No error";
         break;
     case UNPACK_VERSION:
         msg = "Unsupported Data Version";
         break;
     case UNPACK_FORMAT:
         msg = "Unsupported Data Format";
         break;
     case UNPACK_COMPRESSION_VERSION:
         msg = "Unsupported Compression Version";
         break;
     case UNPACK_COMPRESSION_SLICES:
         msg = "Unsupported Number of Slices for Compression Version";
         break;
     case UNPACK_DATA_TRUNCATED:
         msg = "Premature End of Sub-block Data";
         break;
     case UNPACK_EXCESS_DATA:
         msg = "Excess Data in Sub-block";
         break;
     case UNPACK_SOURCE_ID:
         msg = "Invalid Source ID in Sub-block Data";
         break;
     case UNPACK_EXCESS_TOBS:
         msg = "Excess TOBs in Sub-block Data";
         break;
     case UNPACK_DATA_ID:
         msg = "Invalid word ID in Sub-block Data";
         break;
     default:
         msg = "Unknown Error Code";
         break;
     }
     return msg;
 }

◆ unpackerSuccess()

bool LVL1BS::L1CaloSubBlock::unpackerSuccess ( ) const

inlineinherited

Return unpacker success flag.

Definition at line 354 of file L1CaloSubBlock.h.

 {
   return m_unpackerFlag;
 }

◆ unpackNeutral()

bool LVL1BS::CmmJetSubBlock::unpackNeutral ( )

private

Unpack neutral data.

Definition at line 254 of file CmmJetSubBlock.cxx.

 {
   resize();
   int bunchCrossing = 0;
   int overflow = 0;
   int parity = 0;
   const int slices = timeslices();
   for (int slice = 0; slice < slices; ++slice) {
     unsigned int hits = 0;
     int error = 0;
     for (int pin = 0; pin <= TOTAL_MAIN; ++pin) {
       // Jem hits; remote, local and total main hits; parity error
       hits  = unpackerNeutral(pin, s_jetHitsBits);
       error = unpackerNeutral(pin, s_jetHitsErrorBits);
       setJetHits(slice, pin, hits, error);
       // Bunch crossing number; Fifo overflow
       if (pin < s_bunchCrossingBits) {
         bunchCrossing |= unpackerNeutral(pin, 1) << pin;
       } else if (pin == s_fifoOverflowPin) {
         overflow |= unpackerNeutral(pin, 1);
       } else unpackerNeutral(pin, 1);
       // Padding
       if (pin < REMOTE_MAIN) unpackerNeutral(pin, s_paddingBits);
     }
     // ET Map + padding
     setJetEtMap(slice, unpackerNeutral(REMOTE_MAIN, s_paddingBits));
     // Total forward (left + right)
     hits  = unpackerNeutral(LOCAL_MAIN, s_paddingBits);
     hits |= unpackerNeutral(TOTAL_MAIN, s_paddingBits) << s_rightBit;
     setJetHits(slice, TOTAL_FORWARD, hits, 0);
     // Remote + Local forward
     const int lastpin = TOTAL_MAIN + 1;
     hits  = unpackerNeutral(lastpin, s_fwdHitsBits);
     error = unpackerNeutral(lastpin, s_jetHitsErrorBits);
     setJetHits(slice, REMOTE_FORWARD, hits, error);
     unpackerNeutral(lastpin, 1);
     setJetHits(slice, LOCAL_FORWARD,
                       unpackerNeutral(lastpin, s_fwdHitsBits), 0);
     // G-Link parity errors
     for (int pin = 0; pin <= lastpin; ++pin) {
       parity |= unpackerNeutralParityError(pin);
     }
   }
   setBunchCrossing(bunchCrossing);
   setDaqOverflow(overflow);
   setGlinkParity(parity);
  
   const bool rc = unpackerSuccess();
   if (!rc) setUnpackErrorCode(UNPACK_DATA_TRUNCATED);
   return rc;
 }

◆ unpackUncompressed()

bool LVL1BS::CmmJetSubBlock::unpackUncompressed ( )

private

Unpack uncompressed data.

Definition at line 308 of file CmmJetSubBlock.cxx.

 {
   resize();
   unpackerInit();
   uint32_t word = unpacker(s_wordLength);
   while (unpackerSuccess()) {
     const int source = sourceId(word);
     if (source < s_maxHits && m_hitsData[source] == 0) m_hitsData[source] = word;
     else {
       setUnpackErrorCode(UNPACK_SOURCE_ID);
       return false;
     }
     word = unpacker(s_wordLength);
   }
   return true;
 }

◆ upstreamError()

bool LVL1BS::L1CaloSubBlock::upstreamError ( ) const

inlineinherited

Definition at line 298 of file L1CaloSubBlock.h.

 {
   return m_trailer & (0x1 << s_upstreamErrorBit);
 }

◆ version() [1/2]

int LVL1BS::L1CaloSubBlock::version ( ) const

inlineinherited

Definition at line 243 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_versionBit) & s_versionMask;
 }

◆ version() [2/2]

int LVL1BS::L1CaloSubBlock::version ( uint32_t word )

staticinherited

Return version number from given header word.

Definition at line 499 of file L1CaloSubBlock.cxx.

 {
     return (word >> s_versionBit) & s_versionMask;
 }

◆ wordId() [1/2]

int LVL1BS::L1CaloSubBlock::wordId ( ) const

inlineinherited

Definition at line 238 of file L1CaloSubBlock.h.

 {
   return (m_header >> s_wordIdBit) & s_wordIdMask;
 }

◆ wordId() [2/2]

int LVL1BS::L1CaloSubBlock::wordId ( uint32_t word )

staticinherited

Return wordID field from given header word.

Definition at line 492 of file L1CaloSubBlock.cxx.

 {
     return (word >> s_wordIdBit) & s_wordIdMask;
 }

◆ wordType()

L1CaloSubBlock::SubBlockWordType LVL1BS::L1CaloSubBlock::wordType ( uint32_t word )

staticinherited

Word identification.

Definition at line 479 of file L1CaloSubBlock.cxx.

 {
     SubBlockWordType type = DATA;
     if (((word >> s_headerBit) & s_headerMask) == s_headerVal)
     {
         if (((word >> s_statusBit) & s_statusMask) == s_statusVal) type = STATUS;
         else type = HEADER;
     }
     return type;
 }

◆ write()

void LVL1BS::L1CaloSubBlock::write ( FullEventAssembler< L1CaloSrcIdMap >::RODDATA * theROD ) const

inherited

Output complete packed sub-block to ROD vector.

Definition at line 165 of file L1CaloSubBlock.cxx.

 {
     theROD->push_back(m_header);
     std::vector<uint32_t>::const_iterator pos;
     for (pos = m_data.begin(); pos != m_data.end(); ++pos)
     {
         theROD->push_back(*pos);
     }
     if (m_trailer) theROD->push_back(m_trailer);
 }

Member Data Documentation

◆ m_bitword

uint32_t LVL1BS::L1CaloSubBlock::m_bitword

privateinherited

Definition at line 214 of file L1CaloSubBlock.h.

◆ m_bunchCrossing

int LVL1BS::L1CaloSubBlock::m_bunchCrossing

privateinherited

Bunch Crossing number (neutral format only)

Definition at line 210 of file L1CaloSubBlock.h.

◆ m_currentBit

int LVL1BS::L1CaloSubBlock::m_currentBit

privateinherited

Definition at line 215 of file L1CaloSubBlock.h.

◆ m_currentPinBit

std::vector<int> LVL1BS::L1CaloSubBlock::m_currentPinBit

privateinherited

Definition at line 222 of file L1CaloSubBlock.h.

◆ m_data

std::vector<uint32_t> LVL1BS::L1CaloSubBlock::m_data

privateinherited

Sub-Block data.

Definition at line 227 of file L1CaloSubBlock.h.

◆ m_dataPos

std::vector<uint32_t>::const_iterator LVL1BS::L1CaloSubBlock::m_dataPos

privateinherited

Definition at line 219 of file L1CaloSubBlock.h.

◆ m_dataPosEnd

std::vector<uint32_t>::const_iterator LVL1BS::L1CaloSubBlock::m_dataPosEnd

privateinherited

Definition at line 220 of file L1CaloSubBlock.h.

◆ m_dataWords

int LVL1BS::L1CaloSubBlock::m_dataWords

privateinherited

Current number of data words.

Definition at line 225 of file L1CaloSubBlock.h.

◆ m_header

uint32_t LVL1BS::L1CaloSubBlock::m_header

privateinherited

Sub-Block Header.

Definition at line 206 of file L1CaloSubBlock.h.

◆ m_hitsData

std::vector<uint32_t> LVL1BS::CmmJetSubBlock::m_hitsData

private

JEM hits and sums data.

Definition at line 94 of file CmmJetSubBlock.h.

◆ m_maxBits

int LVL1BS::L1CaloSubBlock::m_maxBits

privateinherited

Definition at line 216 of file L1CaloSubBlock.h.

◆ m_maxMask

uint32_t LVL1BS::L1CaloSubBlock::m_maxMask

privateinherited

Definition at line 217 of file L1CaloSubBlock.h.

◆ m_oddParity

std::vector<int> LVL1BS::L1CaloSubBlock::m_oddParity

privateinherited

Definition at line 223 of file L1CaloSubBlock.h.

◆ m_trailer

uint32_t LVL1BS::L1CaloSubBlock::m_trailer

privateinherited

Sub-Block Status Trailer.

Definition at line 208 of file L1CaloSubBlock.h.

◆ m_unpackerFlag

bool LVL1BS::L1CaloSubBlock::m_unpackerFlag

privateinherited

Definition at line 218 of file L1CaloSubBlock.h.

◆ m_unpackError

int LVL1BS::L1CaloSubBlock::m_unpackError

privateinherited

Unpacking error code.

Definition at line 212 of file L1CaloSubBlock.h.

◆ m_unpackingMasks

std::vector<uint32_t> LVL1BS::L1CaloSubBlock::m_unpackingMasks

privateinherited

Unpacking masks.

Definition at line 229 of file L1CaloSubBlock.h.

◆ s_bcnMismatchBit

const int LVL1BS::L1CaloSubBlock::s_bcnMismatchBit = 2

staticprivateinherited

Definition at line 192 of file L1CaloSubBlock.h.

◆ s_bunchCrossingBits

const int LVL1BS::CmmJetSubBlock::s_bunchCrossingBits = 12

staticprivate

Definition at line 75 of file CmmJetSubBlock.h.

◆ s_cmmFirmwareBit

const int LVL1BS::CmmSubBlock::s_cmmFirmwareBit = 1

staticprivateinherited

Definition at line 53 of file CmmSubBlock.h.

◆ s_cmmFirmwareMask

const uint32_t LVL1BS::CmmSubBlock::s_cmmFirmwareMask = 0x3

staticprivateinherited

Definition at line 56 of file CmmSubBlock.h.

◆ s_cmmPositionBit

const int LVL1BS::CmmSubBlock::s_cmmPositionBit = 0

staticprivateinherited

Definition at line 54 of file CmmSubBlock.h.

◆ s_cmmPositionMask

const uint32_t LVL1BS::CmmSubBlock::s_cmmPositionMask = 0x1

staticprivateinherited

Definition at line 57 of file CmmSubBlock.h.

◆ s_cmmSummingBit

const int LVL1BS::CmmSubBlock::s_cmmSummingBit = 3

staticprivateinherited

Definition at line 52 of file CmmSubBlock.h.

◆ s_cmmSummingMask

const uint32_t LVL1BS::CmmSubBlock::s_cmmSummingMask = 0x1

staticprivateinherited

Definition at line 55 of file CmmSubBlock.h.

◆ s_crateBit

const int LVL1BS::L1CaloSubBlock::s_crateBit = 12

staticprivateinherited

Definition at line 174 of file L1CaloSubBlock.h.

◆ s_crateMask

const uint32_t LVL1BS::L1CaloSubBlock::s_crateMask = 0xf

staticprivateinherited

Definition at line 182 of file L1CaloSubBlock.h.

◆ s_daqOverflowBit

const int LVL1BS::L1CaloSubBlock::s_daqOverflowBit = 3

staticprivateinherited

Definition at line 191 of file L1CaloSubBlock.h.

◆ s_dataWordId

const int LVL1BS::CmmJetSubBlock::s_dataWordId = 0

staticprivate

Definition at line 64 of file CmmJetSubBlock.h.

◆ s_dataWordIdBit

const int LVL1BS::CmmJetSubBlock::s_dataWordIdBit = 30

staticprivate

Definition at line 63 of file CmmJetSubBlock.h.

◆ s_errorMask

const uint32_t LVL1BS::CmmJetSubBlock::s_errorMask = 0x1

staticprivate

Definition at line 69 of file CmmJetSubBlock.h.

◆ s_etMapBit

const int LVL1BS::CmmJetSubBlock::s_etMapBit = 17

staticprivate

Definition at line 60 of file CmmJetSubBlock.h.

◆ s_etMapMask

const uint32_t LVL1BS::CmmJetSubBlock::s_etMapMask = 0xf

staticprivate

Definition at line 68 of file CmmJetSubBlock.h.

◆ s_failingBcnBit

const int LVL1BS::L1CaloSubBlock::s_failingBcnBit = 22

staticprivateinherited

Definition at line 187 of file L1CaloSubBlock.h.

◆ s_failingBcnMask

const uint32_t LVL1BS::L1CaloSubBlock::s_failingBcnMask = 0x3f

staticprivateinherited

Definition at line 195 of file L1CaloSubBlock.h.

◆ s_fifoOverflowPin

const int LVL1BS::CmmJetSubBlock::s_fifoOverflowPin = 15

staticprivate

Definition at line 78 of file CmmJetSubBlock.h.

◆ s_formatBit

const int LVL1BS::L1CaloSubBlock::s_formatBit = 22

staticprivateinherited

Definition at line 172 of file L1CaloSubBlock.h.

◆ s_formatMask

const uint32_t LVL1BS::L1CaloSubBlock::s_formatMask = 0x7

staticprivateinherited

Definition at line 180 of file L1CaloSubBlock.h.

◆ s_fwdErrorBit

const int LVL1BS::CmmJetSubBlock::s_fwdErrorBit = 16

staticprivate

Definition at line 59 of file CmmJetSubBlock.h.

◆ s_fwdHitsBits

const int LVL1BS::CmmJetSubBlock::s_fwdHitsBits = 16

staticprivate

Definition at line 74 of file CmmJetSubBlock.h.

◆ s_fwdMask

const uint32_t LVL1BS::CmmJetSubBlock::s_fwdMask = 0xffff

staticprivate

Definition at line 67 of file CmmJetSubBlock.h.

◆ s_glinkBitsPerSlice

const int LVL1BS::CmmSubBlock::s_glinkBitsPerSlice = 35

staticprivateinherited

Needed for neutral format.

Definition at line 59 of file CmmSubBlock.h.

◆ s_glinkDavSet

const uint32_t LVL1BS::L1CaloSubBlock::s_glinkDavSet = 0x400000

staticprivateinherited

Definition at line 203 of file L1CaloSubBlock.h.

◆ s_glinkDownBit

const int LVL1BS::L1CaloSubBlock::s_glinkDownBit = 6

staticprivateinherited

Definition at line 189 of file L1CaloSubBlock.h.

◆ s_glinkParityBit

const int LVL1BS::L1CaloSubBlock::s_glinkParityBit = 0

staticprivateinherited

Definition at line 194 of file L1CaloSubBlock.h.

◆ s_glinkProtocolBit

const int LVL1BS::L1CaloSubBlock::s_glinkProtocolBit = 1

staticprivateinherited

Definition at line 193 of file L1CaloSubBlock.h.

◆ s_glinkTimeoutBit

const int LVL1BS::L1CaloSubBlock::s_glinkTimeoutBit = 7

staticprivateinherited

Definition at line 188 of file L1CaloSubBlock.h.

◆ s_headerBit

const int LVL1BS::L1CaloSubBlock::s_headerBit = 30

staticprivateinherited

Definition at line 161 of file L1CaloSubBlock.h.

◆ s_headerMask

const uint32_t LVL1BS::L1CaloSubBlock::s_headerMask = 0x3

staticprivateinherited

Definition at line 163 of file L1CaloSubBlock.h.

◆ s_headerVal

const uint32_t LVL1BS::L1CaloSubBlock::s_headerVal = 0x3

staticprivateinherited

Definition at line 165 of file L1CaloSubBlock.h.

◆ s_jetHitsBits

const int LVL1BS::CmmJetSubBlock::s_jetHitsBits = 24

staticprivate

Definition at line 72 of file CmmJetSubBlock.h.

◆ s_jetHitsErrorBits

const int LVL1BS::CmmJetSubBlock::s_jetHitsErrorBits = 1

staticprivate

Definition at line 73 of file CmmJetSubBlock.h.

◆ s_maxHits

const int LVL1BS::CmmJetSubBlock::s_maxHits = 23

staticprivate

Definition at line 65 of file CmmJetSubBlock.h.

◆ s_maxPins

const int LVL1BS::L1CaloSubBlock::s_maxPins = 20

staticprivateinherited

Definition at line 202 of file L1CaloSubBlock.h.

◆ s_maxStreamedBits

const int LVL1BS::L1CaloSubBlock::s_maxStreamedBits = 31

staticprivateinherited

Definition at line 198 of file L1CaloSubBlock.h.

◆ s_maxStreamedMask

const uint32_t LVL1BS::L1CaloSubBlock::s_maxStreamedMask = 0x7fffffff

staticprivateinherited

Definition at line 200 of file L1CaloSubBlock.h.

◆ s_maxWordBits

const int LVL1BS::L1CaloSubBlock::s_maxWordBits = 32

staticprivateinherited

Definition at line 197 of file L1CaloSubBlock.h.

◆ s_maxWordMask

const uint32_t LVL1BS::L1CaloSubBlock::s_maxWordMask = 0xffffffff

staticprivateinherited

Definition at line 199 of file L1CaloSubBlock.h.

◆ s_moduleBit

const int LVL1BS::L1CaloSubBlock::s_moduleBit = 8

staticprivateinherited

Definition at line 175 of file L1CaloSubBlock.h.

◆ s_moduleMask

const uint32_t LVL1BS::L1CaloSubBlock::s_moduleMask = 0xf

staticprivateinherited

Definition at line 183 of file L1CaloSubBlock.h.

◆ s_paddingBits

const int LVL1BS::CmmJetSubBlock::s_paddingBits = 8

staticprivate

Definition at line 76 of file CmmJetSubBlock.h.

◆ s_ppmCrates

const int LVL1BS::L1CaloSubBlock::s_ppmCrates = 8

staticprivateinherited

Definition at line 168 of file L1CaloSubBlock.h.

◆ s_rightBit

const int LVL1BS::CmmJetSubBlock::s_rightBit = 8

staticprivate

Definition at line 77 of file CmmJetSubBlock.h.

◆ s_seqnoBit

const int LVL1BS::L1CaloSubBlock::s_seqnoBit = 16

staticprivateinherited

Definition at line 173 of file L1CaloSubBlock.h.

◆ s_seqnoMask

const uint32_t LVL1BS::L1CaloSubBlock::s_seqnoMask = 0x3f

staticprivateinherited

Definition at line 181 of file L1CaloSubBlock.h.

◆ s_slices1Bit

const int LVL1BS::L1CaloSubBlock::s_slices1Bit = 0

staticprivateinherited

Definition at line 177 of file L1CaloSubBlock.h.

◆ s_slices1Mask

const uint32_t LVL1BS::L1CaloSubBlock::s_slices1Mask = 0x7

staticprivateinherited

Definition at line 185 of file L1CaloSubBlock.h.

◆ s_slices2Bit

const int LVL1BS::L1CaloSubBlock::s_slices2Bit = 3

staticprivateinherited

Definition at line 176 of file L1CaloSubBlock.h.

◆ s_slices2Mask

const uint32_t LVL1BS::L1CaloSubBlock::s_slices2Mask = 0x1f

staticprivateinherited

Definition at line 184 of file L1CaloSubBlock.h.

◆ s_sourceIdBit

const int LVL1BS::CmmJetSubBlock::s_sourceIdBit = 25

staticprivate

Definition at line 62 of file CmmJetSubBlock.h.

◆ s_sourceIdMask

const uint32_t LVL1BS::CmmJetSubBlock::s_sourceIdMask = 0x1f

staticprivate

Definition at line 70 of file CmmJetSubBlock.h.

◆ s_statusBit

const int LVL1BS::L1CaloSubBlock::s_statusBit = 28

staticprivateinherited

Definition at line 162 of file L1CaloSubBlock.h.

◆ s_statusMask

const uint32_t LVL1BS::L1CaloSubBlock::s_statusMask = 0x1

staticprivateinherited

Definition at line 164 of file L1CaloSubBlock.h.

◆ s_statusVal

const uint32_t LVL1BS::L1CaloSubBlock::s_statusVal = 0x1

staticprivateinherited

Definition at line 166 of file L1CaloSubBlock.h.

◆ s_threshBit

const int LVL1BS::CmmJetSubBlock::s_threshBit = 0

staticprivate

Definition at line 58 of file CmmJetSubBlock.h.

◆ s_threshErrorBit

const int LVL1BS::CmmJetSubBlock::s_threshErrorBit = 24

staticprivate

Definition at line 61 of file CmmJetSubBlock.h.

◆ s_threshMask

const uint32_t LVL1BS::CmmJetSubBlock::s_threshMask = 0xffffff

staticprivate

Definition at line 66 of file CmmJetSubBlock.h.

◆ s_upstreamErrorBit

const int LVL1BS::L1CaloSubBlock::s_upstreamErrorBit = 4

staticprivateinherited

Definition at line 190 of file L1CaloSubBlock.h.

◆ s_versionBit

const int LVL1BS::L1CaloSubBlock::s_versionBit = 25

staticprivateinherited

Definition at line 171 of file L1CaloSubBlock.h.

◆ s_versionMask

const uint32_t LVL1BS::L1CaloSubBlock::s_versionMask = 0x7

staticprivateinherited

Definition at line 179 of file L1CaloSubBlock.h.

◆ s_wordIdBit

const int LVL1BS::L1CaloSubBlock::s_wordIdBit = 28

staticprivateinherited

Definition at line 170 of file L1CaloSubBlock.h.

◆ s_wordIdMask

const uint32_t LVL1BS::L1CaloSubBlock::s_wordIdMask = 0xf

staticprivateinherited

Definition at line 178 of file L1CaloSubBlock.h.

◆ s_wordIdVal

const int LVL1BS::CmmSubBlock::s_wordIdVal = 0xe

staticprivateinherited

CMM header word ID.

Definition at line 50 of file CmmSubBlock.h.

◆ s_wordLength

const int LVL1BS::CmmJetSubBlock::s_wordLength = 32

staticprivate

Data word length.

Definition at line 56 of file CmmJetSubBlock.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CmmFirmwareCode

◆ CmmPositions

◆ CmmSummingCode

◆ DataErrorType

◆ DataFormats

◆ SourceId

◆ SubBlockWordType

◆ UnpackErrorType

Constructor & Destructor Documentation

◆ CmmJetSubBlock()

◆ ~CmmJetSubBlock()

Member Function Documentation

◆ bcnMismatch()

◆ bunchCrossing()

◆ clear()

◆ cmmBlock()

◆ cmmFirmware()

◆ cmmPosition()

◆ cmmSumming()

◆ cmmType()

◆ crate()

◆ currentPinBit()

◆ daqOverflow()

◆ dataWords()

◆ failingBCN()

◆ format() [1/2]

◆ format() [2/2]

◆ glinkDown()

◆ glinkParity()

◆ glinkProtocol()

◆ glinkTimeout()

◆ index()

◆ jetEtMap()

◆ jetHits()

◆ jetHitsError()

◆ minBits()

◆ module() [1/2]

◆ module() [2/2]

◆ pack()

◆ packer()

◆ packerFlush()

◆ packerNeutral()

◆ packerNeutralParity()

◆ packNeutral()

◆ packUncompressed()

◆ parityBit()

◆ read()

◆ resize()

◆ seqno() [1/2]

◆ seqno() [2/2]

◆ setBunchCrossing()

◆ setCmmHeader()

◆ setDaqOverflow()

◆ setGlinkParity()

◆ setHeader()

◆ setJetEtMap()

◆ setJetHits()

◆ setStatus()

◆ setStreamed()

◆ setUnpackErrorCode()

◆ slice()

◆ slices1()

◆ slices2()

◆ sourceId()

◆ subStatus()

◆ timeslices()

◆ unpack()

◆ unpacker() [1/2]

◆ unpacker() [2/2]

◆ unpackerInit()

◆ unpackerNeutral()

◆ unpackerNeutralParityError()