Sub-Block class for CPM data. More...

#include <CpmSubBlockV1.h>

Inheritance diagram for LVL1BS::CpmSubBlockV1:

Collaboration diagram for LVL1BS::CpmSubBlockV1:

Public Types
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
	CpmSubBlockV1 ()

	~CpmSubBlockV1 ()

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

void	setCpmHeader (int version, int format, int slice, int crate, int module, int timeslices)
	Store CPM header. More...

void	fillTowerData (int slice, int channel, int em, int had, int emErr, int hadErr)
	Store trigger tower data. More...

void	setHits (int slice, unsigned int hit0, unsigned int hit1)
	Store hit counts. More...

int	emData (int slice, int channel) const
	Return Em data for given channel. More...

int	hadData (int slice, int channel) const
	Return Had data for given channel. More...

int	emError (int slice, int channel) const
	Return Em error for given channel. More...

int	hadError (int slice, int channel) const
	Return Had error for given channel. More...

unsigned int	hits0 (int slice) const
	Return e/gamma hit counts. More...

unsigned int	hits1 (int slice) const
	Return tau hit counts. More...

int	timeslices () const
	Return number of timeslices. More...

bool	anyTowerData (int channel) const
	Return true if there is tower data for given channel. More...

bool	pack ()
	Pack data. More...

bool	unpack ()
	Unpack data. More...

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 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	dataId (uint32_t word) const
	Return data WordID. More...

int	data (int slice, int channel, int offset) const
	Return data for given channel and pin offset. More...

int	error (int slice, int channel, int offset) const
	Return error for given channel and pin offset. More...

unsigned int	hits (int slice, int offset) const
	Return hit counts with given offset. More...

int	index (int slice) const
	Return data index appropriate to format. More...

void	resize (std::vector< uint32_t > &vec, int channels)
	Resize a data vector according to format. More...

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_ttData
	Trigger tower data. More...

std::vector< uint32_t >	m_hitData
	Hit counts. More...

std::vector< int >	m_chanPresent
	Channel present flags vector. More...

int	m_channels
	Number of Trigger tower channels per module. 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_wordIdVal = 0xc
	CPM header word ID. More...

static const int	s_wordLength = 32
	Data word length. More...

static const int	s_ttDataABit = 0

static const int	s_ttDataBBit = 9

static const int	s_parityABit = 8

static const int	s_parityBBit = 17

static const int	s_linkDownABit = 19

static const int	s_linkDownBBit = 20

static const int	s_pairBit = 21

static const int	s_fpgaBit = 23

static const int	s_dataIdBit = 30

static const int	s_ttWordId = 0x1

static const uint32_t	s_ttDataMask = 0xff

static const uint32_t	s_pairPinMask = 0x7f

static const uint32_t	s_dataIdMask = 0x3

static const int	s_indicatorBit = 24

static const uint32_t	s_threshWordId = 0x2

static const uint32_t	s_threshMask = 0xffffff

static const int	s_pairsPerPin = 4

static const int	s_wordsPerPin = 8

static const int	s_ttBits = 8

static const int	s_errBits = 2

static const int	s_hitBits = 3

static const int	s_hitWords = 8

static const int	s_glinkPins = 20

static const int	s_glinkBitsPerSlice = 84

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 CPM data.

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

Author: Peter Faulkner

Definition at line 23 of file CpmSubBlockV1.h.

Member Enumeration Documentation

◆ 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 };

◆ 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

◆ CpmSubBlockV1()

LVL1BS::CpmSubBlockV1::CpmSubBlockV1 ( )

Definition at line 44 of file CpmSubBlockV1.cxx.

                              : m_channels(80)
 {
   m_chanPresent.assign(m_channels, 0);
 }

◆ ~CpmSubBlockV1()

LVL1BS::CpmSubBlockV1::~CpmSubBlockV1 ( )

Definition at line 49 of file CpmSubBlockV1.cxx.

50 {

51 }

Member Function Documentation

◆ anyTowerData()

bool LVL1BS::CpmSubBlockV1::anyTowerData ( int channel ) const

inline

Return true if there is tower data for given channel.

Definition at line 134 of file CpmSubBlockV1.h.

 {
   return m_chanPresent[channel];
 }

◆ 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::CpmSubBlockV1::clear ( )

Clear all data.

Definition at line 55 of file CpmSubBlockV1.cxx.

 {
   L1CaloSubBlock::clear();
   m_ttData.clear();
   m_hitData.clear();
   m_chanPresent.assign(m_channels, 0);
 }

◆ 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);
 }

◆ data()

int LVL1BS::CpmSubBlockV1::data	(	int	slice,
		int	channel,
		int	offset
	)		const

private

Return data for given channel and pin offset.

Definition at line 235 of file CpmSubBlockV1.cxx.

 {
   int dat = 0;
   if (slice >= 0 && slice < timeslices() &&
       channel >= 0 && channel < m_channels && !m_ttData.empty()) {
     const int pin  = 2 * (channel/s_wordsPerPin) + offset;
     const int pair = (channel % s_wordsPerPin) / 2;
     const int pos  = pin * s_pairsPerPin + pair;
     const int ix   = index(slice) * m_channels + pos;
     const uint32_t word = m_ttData[ix];
     if (channel % 2 == 0) {
            dat = (word >> s_ttDataABit) & s_ttDataMask;
     } else dat = (word >> s_ttDataBBit) & s_ttDataMask;
   }
   return dat;
 }

◆ dataId()

int LVL1BS::CpmSubBlockV1::dataId ( uint32_t word ) const

inlineprivate

Return data WordID.

Definition at line 129 of file CpmSubBlockV1.h.

 {
   return (word >> s_dataIdBit) & s_dataIdMask;
 }

◆ dataWords()

int LVL1BS::L1CaloSubBlock::dataWords ( ) const

inlineinherited

Return number of data words.

Definition at line 233 of file L1CaloSubBlock.h.

 {
   return m_dataWords;
 }

◆ emData()

int LVL1BS::CpmSubBlockV1::emData	(	int	slice,
		int	channel
	)		const

Return Em data for given channel.

Definition at line 133 of file CpmSubBlockV1.cxx.

 {
   return data(slice, channel, 0);
 }

◆ emError()

int LVL1BS::CpmSubBlockV1::emError	(	int	slice,
		int	channel
	)		const

Return Em error for given channel.

Definition at line 147 of file CpmSubBlockV1.cxx.

 {
   return error(slice, channel, 0);
 }

◆ error()

int LVL1BS::CpmSubBlockV1::error	(	int	slice,
		int	channel,
		int	offset
	)		const

private

Return error for given channel and pin offset.

Definition at line 255 of file CpmSubBlockV1.cxx.

 {
   int err = 0;
   if (slice >= 0 && slice < timeslices() &&
       channel >= 0 && channel < m_channels && !m_ttData.empty()) {
     const int pin  = 2 * (channel/s_wordsPerPin) + offset;
     const int pair = (channel % s_wordsPerPin) / 2;
     const int pos  = pin * s_pairsPerPin + pair;
     const int ix   = index(slice) * m_channels + pos;
     const uint32_t word = m_ttData[ix];
     if (channel % 2 == 0) {
       err  =  (word >> s_parityABit)   & 0x1;
       err |= ((word >> s_linkDownABit) & 0x1) << 1;
     } else {
       err  =  (word >> s_parityBBit)   & 0x1;
       err |= ((word >> s_linkDownBBit) & 0x1) << 1;
     }
   }
   return err;
 }

◆ failingBCN()

uint32_t LVL1BS::L1CaloSubBlock::failingBCN ( ) const

inlineinherited

Definition at line 283 of file L1CaloSubBlock.h.

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

◆ fillTowerData()

void LVL1BS::CpmSubBlockV1::fillTowerData	(	int	slice,
		int	channel,
		int	em,
		int	had,
		int	emErr,
		int	hadErr
	)

Store trigger tower data.

Definition at line 74 of file CpmSubBlockV1.cxx.

 {
   if (channel < m_channels && (em || emErr || had || hadErr)) {
     resize(m_ttData, m_channels);
     int dat = em;
     int err = emErr;
     for (int pinOffset = 0; pinOffset < 2; ++pinOffset) {
       if (dat || err) {
         const int pin  = 2 * (channel/s_wordsPerPin) + pinOffset;
         const int pair = (channel % s_wordsPerPin) / 2;
         const int pos  = pin * s_pairsPerPin + pair;
         const int ix   = index(slice) * m_channels + pos;
         uint32_t word = m_ttData[ix];
         if (channel % 2 == 0) {
           word |= (dat & s_ttDataMask) << s_ttDataABit;
       word |= (err & 0x1)          << s_parityABit;
       word |= ((err >> 1) & 0x1)   << s_linkDownABit;
         } else {
           word |= (dat & s_ttDataMask) << s_ttDataBBit;
       word |= (err & 0x1)          << s_parityBBit;
       word |= ((err >> 1) & 0x1)   << s_linkDownBBit;
         }
         word |= pair       << s_pairBit;
         word |= pin        << s_fpgaBit;
         word |= s_ttWordId << s_dataIdBit;
         m_ttData[ix] = word;
       }
       dat = had;
       err = hadErr;
     }
     m_chanPresent[channel] = 1;
   }
 }

◆ 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);
 }

◆ hadData()

int LVL1BS::CpmSubBlockV1::hadData	(	int	slice,
		int	channel
	)		const

Return Had data for given channel.

Definition at line 140 of file CpmSubBlockV1.cxx.

 {
   return data(slice, channel, 1);
 }

◆ hadError()

int LVL1BS::CpmSubBlockV1::hadError	(	int	slice,
		int	channel
	)		const

Return Had error for given channel.

Definition at line 154 of file CpmSubBlockV1.cxx.

 {
   return error(slice, channel, 1);
 }

◆ hits()

unsigned int LVL1BS::CpmSubBlockV1::hits	(	int	slice,
		int	offset
	)		const

private

Return hit counts with given offset.

Definition at line 279 of file CpmSubBlockV1.cxx.

 {
   unsigned int hit = 0;
   if (slice >= 0 && slice < timeslices() && !m_hitData.empty()) {
     hit = m_hitData[index(slice)*2 + offset] & s_threshMask;
   }
   return hit;
 }

◆ hits0()

unsigned int LVL1BS::CpmSubBlockV1::hits0 ( int slice ) const

Return e/gamma hit counts.

Definition at line 161 of file CpmSubBlockV1.cxx.

 {
   return hits(slice, 0);
 }

◆ hits1()

unsigned int LVL1BS::CpmSubBlockV1::hits1 ( int slice ) const

Return tau hit counts.

Definition at line 168 of file CpmSubBlockV1.cxx.

 {
   return hits(slice, 1);
 }

◆ index()

int LVL1BS::CpmSubBlockV1::index ( int slice ) const

private

Return data index appropriate to format.

Definition at line 290 of file CpmSubBlockV1.cxx.

 {
   return (format() == NEUTRAL) ? slice : 0;
 }

◆ 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::CpmSubBlockV1::pack ( )

Pack data.

Definition at line 187 of file CpmSubBlockV1.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::CpmSubBlockV1::packNeutral ( )

private

Pack neutral data.

Definition at line 308 of file CpmSubBlockV1.cxx.

 {
   resize(m_ttData, m_channels);
   resize(m_hitData, 2);
   const int slices = timeslices();
   for (int slice = 0; slice < slices; ++slice) {
     const unsigned int hit0 = hits0(slice);
     const unsigned int hit1 = hits1(slice);
     for (int pin = 0; pin < s_glinkPins; ++pin) {
       // Trigger tower data
       for (int pair = 0; pair < s_pairsPerPin; ++pair) {
         for (int i = 0; i < 2; ++i) {
           const int channel = s_wordsPerPin*(pin/2) + 2*pair + i;
       if ((pin & 0x1)) { // Odd pins Had, even Em
         packerNeutral(pin, hadData(slice,  channel), s_ttBits);
         packerNeutral(pin, hadError(slice, channel), s_errBits);
           } else {
         packerNeutral(pin, emData(slice,  channel), s_ttBits);
         packerNeutral(pin, emError(slice, channel), s_errBits);
       }
         }
       }
       // Hits and Bunch Crossing number
       if (pin < s_hitWords) {
         packerNeutral(pin, hit0 >> pin*s_hitBits, s_hitBits);
       } else if (pin < 2*s_hitWords) {
         packerNeutral(pin, hit1 >> (pin - s_hitWords)*s_hitBits, s_hitBits);
       } else {
         packerNeutral(pin, bunchCrossing() >> (pin - 2*s_hitWords)*s_hitBits,
                                                              s_hitBits);
       }
       // G-Link parity
       packerNeutralParity(pin);
     }
   }
   return true;
 }

◆ packUncompressed()

bool LVL1BS::CpmSubBlockV1::packUncompressed ( )

private

Pack uncompressed data.

Definition at line 348 of file CpmSubBlockV1.cxx.

 {
   // Trigger tower data
   std::vector<uint32_t>::const_iterator pos;
   for (pos = m_ttData.begin(); pos != m_ttData.end(); ++pos) {
     if (*pos) packer(*pos, s_wordLength);
   }
         
   // Hits data
   for (pos = m_hitData.begin(); pos != m_hitData.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::CpmSubBlockV1::resize	(	std::vector< uint32_t > &	vec,
		int	channels
	)

private

Resize a data vector according to format.

Definition at line 297 of file CpmSubBlockV1.cxx.

 {
   if (vec.empty()) {
     int size = channels;
     if (format() == NEUTRAL) size *= timeslices();
     vec.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;
 }

◆ setCpmHeader()

void LVL1BS::CpmSubBlockV1::setCpmHeader	(	int	version,
		int	format,
		int	slice,
		int	crate,
		int	module,
		int	timeslices
	)

Store CPM header.

Definition at line 65 of file CpmSubBlockV1.cxx.

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

◆ setHits()

void LVL1BS::CpmSubBlockV1::setHits	(	int	slice,
		unsigned int	hit0,
		unsigned int	hit1
	)

Store hit counts.

Definition at line 112 of file CpmSubBlockV1.cxx.

 {
   if (hit0 || hit1) {
     resize(m_hitData, 2);
     const int ix = index(slice)*2;
     unsigned int hits = hit0;
     for (int indicator = 0; indicator < 2; ++indicator) {
       if (hits) {
         uint32_t word = (hits & s_threshMask);
         word |= indicator      << s_indicatorBit;
         word |= s_threshWordId << s_dataIdBit;
         m_hitData[ix + indicator] = word;
       }
       hits = hit1;
     }
   }
 }

◆ 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;
 }

◆ 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::CpmSubBlockV1::timeslices ( ) const

Return number of timeslices.

Definition at line 175 of file CpmSubBlockV1.cxx.

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

◆ unpack()

bool LVL1BS::CpmSubBlockV1::unpack ( )

Unpack data.

Definition at line 209 of file CpmSubBlockV1.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::CpmSubBlockV1::unpackNeutral ( )

private

Unpack neutral data.

Definition at line 366 of file CpmSubBlockV1.cxx.

 {
   resize(m_ttData, m_channels);
   resize(m_hitData, 2);
   const int slices = timeslices();
   for (int slice = 0; slice < slices; ++slice) {
     unsigned int hit0 = 0;
     unsigned int hit1 = 0;
     int bunchCrossing = 0;
     for (int pin = 0; pin < s_glinkPins; ++pin) {
       // Trigger tower data
       for (int pair = 0; pair < s_pairsPerPin; ++pair) {
     for (int i = 0; i < 2; ++i) {
           const int channel = s_wordsPerPin*(pin/2) + 2*pair + i;
       int em     = 0;
       int had    = 0;
       int emErr  = 0;
       int hadErr = 0;
       if ((pin & 0x1)) { // Odd pins Had, even Em
         em     = emData(slice, channel);
         had    = unpackerNeutral(pin, s_ttBits);
         emErr  = emError(slice, channel);
         hadErr = unpackerNeutral(pin, s_errBits);
       } else {
         em     = unpackerNeutral(pin, s_ttBits);
         had    = hadData(slice, channel);
         emErr  = unpackerNeutral(pin, s_errBits);
         hadErr = hadError(slice, channel);
           }
       fillTowerData(slice, channel, em, had, emErr, hadErr);
         }
       }
       // Hits and Bunch Crossing number
       if (pin < s_hitWords) {
         hit0 |= unpackerNeutral(pin, s_hitBits) << pin*s_hitBits;
       } else if (pin < 2*s_hitWords) {
         hit1 |= unpackerNeutral(pin, s_hitBits) << (pin - s_hitWords)*s_hitBits;
       } else {
     bunchCrossing |= unpackerNeutral(pin, s_hitBits)
                                     << (pin - 2*s_hitWords)*s_hitBits;
       }
       // G-Link parity error
       unpackerNeutralParityError(pin);
     }
     setHits(slice, hit0, hit1);
     setBunchCrossing(bunchCrossing);
   }
   const bool rc = unpackerSuccess();
   if (!rc) setUnpackErrorCode(UNPACK_DATA_TRUNCATED);
   return rc;
 }

◆ unpackUncompressed()

bool LVL1BS::CpmSubBlockV1::unpackUncompressed ( )

private

Unpack uncompressed data.

Definition at line 420 of file CpmSubBlockV1.cxx.

 {
   resize(m_ttData, m_channels);
   resize(m_hitData, 2);
   unpackerInit();
   uint32_t word = unpacker(s_wordLength);
   while (unpackerSuccess()) {
     const int id = dataId(word);
     bool err = false;
     // Trigger tower data
     if (id == s_ttWordId) {
       const int ix = (word >> s_pairBit) & s_pairPinMask;
       if (ix < m_channels && m_ttData[ix] == 0) {
         m_ttData[ix] = word;
     const int pin  = ix/4;
     const int pair = ix%4;
     const int channel = s_wordsPerPin*(pin/2) + 2*pair;
     m_chanPresent[channel]   = 1;
     m_chanPresent[channel+1] = 1;
       } else err = true;
     // Hits
     } else {
       const int indicator = (word >> s_indicatorBit) & 0x1;
       if (m_hitData[indicator] == 0) m_hitData[indicator] = word;
       else err = true;
     }
     if (err) {
       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_channels

int LVL1BS::CpmSubBlockV1::m_channels

private

Number of Trigger tower channels per module.

Definition at line 125 of file CpmSubBlockV1.h.

◆ m_chanPresent

std::vector<int> LVL1BS::CpmSubBlockV1::m_chanPresent

private

Channel present flags vector.

Definition at line 123 of file CpmSubBlockV1.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_hitData

std::vector<uint32_t> LVL1BS::CpmSubBlockV1::m_hitData

private

Hit counts.

Definition at line 121 of file CpmSubBlockV1.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_ttData

std::vector<uint32_t> LVL1BS::CpmSubBlockV1::m_ttData

private

Trigger tower data.

Definition at line 119 of file CpmSubBlockV1.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_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_dataIdBit

const int LVL1BS::CpmSubBlockV1::s_dataIdBit = 30

staticprivate

Definition at line 77 of file CpmSubBlockV1.h.

◆ s_dataIdMask

const uint32_t LVL1BS::CpmSubBlockV1::s_dataIdMask = 0x3

staticprivate

Definition at line 81 of file CpmSubBlockV1.h.

◆ s_errBits

const int LVL1BS::CpmSubBlockV1::s_errBits = 2

staticprivate

Definition at line 90 of file CpmSubBlockV1.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_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_fpgaBit

const int LVL1BS::CpmSubBlockV1::s_fpgaBit = 23

staticprivate

Definition at line 76 of file CpmSubBlockV1.h.

◆ s_glinkBitsPerSlice

const int LVL1BS::CpmSubBlockV1::s_glinkBitsPerSlice = 84

staticprivate

Definition at line 94 of file CpmSubBlockV1.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_glinkPins

const int LVL1BS::CpmSubBlockV1::s_glinkPins = 20

staticprivate

Definition at line 93 of file CpmSubBlockV1.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_hitBits

const int LVL1BS::CpmSubBlockV1::s_hitBits = 3

staticprivate

Definition at line 91 of file CpmSubBlockV1.h.

◆ s_hitWords

const int LVL1BS::CpmSubBlockV1::s_hitWords = 8

staticprivate

Definition at line 92 of file CpmSubBlockV1.h.

◆ s_indicatorBit

const int LVL1BS::CpmSubBlockV1::s_indicatorBit = 24

staticprivate

Definition at line 83 of file CpmSubBlockV1.h.

◆ s_linkDownABit

const int LVL1BS::CpmSubBlockV1::s_linkDownABit = 19

staticprivate

Definition at line 73 of file CpmSubBlockV1.h.

◆ s_linkDownBBit

const int LVL1BS::CpmSubBlockV1::s_linkDownBBit = 20

staticprivate

Definition at line 74 of file CpmSubBlockV1.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_pairBit

const int LVL1BS::CpmSubBlockV1::s_pairBit = 21

staticprivate

Definition at line 75 of file CpmSubBlockV1.h.

◆ s_pairPinMask

const uint32_t LVL1BS::CpmSubBlockV1::s_pairPinMask = 0x7f

staticprivate

Definition at line 80 of file CpmSubBlockV1.h.

◆ s_pairsPerPin

const int LVL1BS::CpmSubBlockV1::s_pairsPerPin = 4

staticprivate

Definition at line 87 of file CpmSubBlockV1.h.

◆ s_parityABit

const int LVL1BS::CpmSubBlockV1::s_parityABit = 8

staticprivate

Definition at line 71 of file CpmSubBlockV1.h.

◆ s_parityBBit

const int LVL1BS::CpmSubBlockV1::s_parityBBit = 17

staticprivate

Definition at line 72 of file CpmSubBlockV1.h.

◆ s_ppmCrates

const int LVL1BS::L1CaloSubBlock::s_ppmCrates = 8

staticprivateinherited

Definition at line 168 of file L1CaloSubBlock.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_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_threshMask

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

staticprivate

Definition at line 85 of file CpmSubBlockV1.h.

◆ s_threshWordId

const uint32_t LVL1BS::CpmSubBlockV1::s_threshWordId = 0x2

staticprivate

Definition at line 84 of file CpmSubBlockV1.h.

◆ s_ttBits

const int LVL1BS::CpmSubBlockV1::s_ttBits = 8

staticprivate

Definition at line 89 of file CpmSubBlockV1.h.

◆ s_ttDataABit

const int LVL1BS::CpmSubBlockV1::s_ttDataABit = 0

staticprivate

Definition at line 69 of file CpmSubBlockV1.h.

◆ s_ttDataBBit

const int LVL1BS::CpmSubBlockV1::s_ttDataBBit = 9

staticprivate

Definition at line 70 of file CpmSubBlockV1.h.

◆ s_ttDataMask

const uint32_t LVL1BS::CpmSubBlockV1::s_ttDataMask = 0xff

staticprivate

Definition at line 79 of file CpmSubBlockV1.h.

◆ s_ttWordId

const int LVL1BS::CpmSubBlockV1::s_ttWordId = 0x1

staticprivate

Definition at line 78 of file CpmSubBlockV1.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::CpmSubBlockV1::s_wordIdVal = 0xc

staticprivate

CPM header word ID.

Definition at line 65 of file CpmSubBlockV1.h.

◆ s_wordLength

const int LVL1BS::CpmSubBlockV1::s_wordLength = 32

staticprivate

Data word length.

Definition at line 67 of file CpmSubBlockV1.h.

◆ s_wordsPerPin

const int LVL1BS::CpmSubBlockV1::s_wordsPerPin = 8

staticprivate

Definition at line 88 of file CpmSubBlockV1.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

◆ DataErrorType

◆ DataFormats

◆ SubBlockWordType

◆ UnpackErrorType

Constructor & Destructor Documentation

◆ CpmSubBlockV1()

◆ ~CpmSubBlockV1()

Member Function Documentation

◆ anyTowerData()

◆ bcnMismatch()

◆ bunchCrossing()

◆ clear()

◆ crate()

◆ currentPinBit()

◆ daqOverflow()

◆ data()

◆ dataId()

◆ dataWords()

◆ emData()

◆ emError()

◆ error()

◆ failingBCN()

◆ fillTowerData()

◆ format() [1/2]

◆ format() [2/2]

◆ glinkDown()

◆ glinkParity()

◆ glinkProtocol()

◆ glinkTimeout()

◆ hadData()

◆ hadError()

◆ hits()

◆ hits0()

◆ hits1()

◆ index()

◆ minBits()

◆ module() [1/2]

◆ module() [2/2]

◆ pack()

◆ packer()

◆ packerFlush()

◆ packerNeutral()

◆ packerNeutralParity()

◆ packNeutral()

◆ packUncompressed()

◆ parityBit()

◆ read()

◆ resize()

◆ seqno() [1/2]

◆ seqno() [2/2]

◆ setBunchCrossing()

◆ setCpmHeader()

◆ setDaqOverflow()

◆ setGlinkParity()

◆ setHeader()

◆ setHits()

◆ setStatus()

◆ setStreamed()

◆ setUnpackErrorCode()

◆ slice()

◆ slices1()

◆ slices2()

◆ subStatus()

◆ timeslices()

◆ unpack()

◆ unpacker() [1/2]

◆ unpacker() [2/2]

◆ unpackerInit()

◆ unpackerNeutral()

◆ unpackerNeutralParityError()

◆ unpackErrorCode()

◆ unpackErrorMsg()