L1GtfeExtWord Class Reference

#include <L1GtfeExtWord.h>

Inheritance diagram for L1GtfeExtWord:

Public Member Functions
const cms_uint16_t	beamMode () const
const cms_uint16_t	beamMomentum () const
const std::vector< cms_uint16_t > &	bst () const
	get the full BST block More...
const cms_uint16_t	bst (int iB) const
	get/set BST block for index iB More...
const unsigned int	bstLengthBytes () const
	get the size of the BST block More...
const cms_uint16_t	bstMasterStatus () const
const cms_uint16_t	bstSource () const
	get/set hex message indicating the source of BST message More...
const unsigned int	getSize () const
	get the size of the GTFE block in GT EVM record (in multiple of 8 bits) More...
const cms_uint64_t	gpsTime () const
	LHC-BOB-ES-0001 (EDMS 638899) More...
	L1GtfeExtWord ()
	constructors More...
	L1GtfeExtWord (int bstSizeBytes)
	all members set to zero, m_bst has bstSizeBytes zero elements More...
	L1GtfeExtWord (cms_uint16_t boardIdValue, cms_uint16_t recordLengthValue, cms_uint16_t recordLength1Value, cms_uint16_t bxNrValue, cms_uint32_t setupVersionValue, cms_uint16_t activeBoardsValue, cms_uint16_t altNrBxBoardValue, cms_uint32_t totalTriggerNrValue, const std::vector< cms_uint16_t > &bstValue, cms_uint16_t bstSourceValue)
	constructor from unpacked values, m_bst size taken from bstValue More...
const cms_uint32_t	lhcFillNumber () const
bool	operator!= (const L1GtfeExtWord &) const
	unequal operator More...
bool	operator== (const L1GtfeExtWord &) const
	equal operator More...
const cms_uint16_t	particleTypeBeam1 () const
const cms_uint16_t	particleTypeBeam2 () const
void	print (std::ostream &myCout) const override
	pretty print the content of a L1GtfeExtWord More...
void	reset () override
	reset the content of a L1GtfeExtWord More...
void	resize (int bstSizeBytes)
	resize the BST vector to get the right size of the block More...
void	setBst (const cms_uint16_t bstVal, const int iB)
void	setBst (const cms_uint64_t &word64, const int iB)
	set the BST block for index iB from a 64-bits word More...
void	setBstSource (const cms_uint16_t bstSourceVal)
void	setBstSource (const cms_uint64_t &word64)
	set the hex message indicating the source of BST message from a 64-bits word More...
void	setBstSourceWord64 (cms_uint64_t &word64, const int iWord)
void	setBstWord64 (cms_uint64_t &word64, int iB, const int iWord)
void	setGpsTime (const cms_uint64_t)
const cms_uint32_t	totalIntensityBeam1 () const
const cms_uint32_t	totalIntensityBeam2 () const
const cms_uint32_t	turnCountNumber () const
void	unpack (const unsigned char *gtfePtr) override
	~L1GtfeExtWord () override
	destructor More...
Public Member Functions inherited from L1GtfeWord
const cms_uint16_t	activeBoards () const
	get/set boards contributing to EVM respectively DAQ record More...
const cms_uint16_t	altNrBxBoard () const
	get/set alternative for number of BX per board More...
const cms_uint16_t	boardId () const
	get/set board ID More...
const int	bstFlag () const
	get / set BST flag: 0 or 1 - via setup version (no private member) More...
const cms_uint16_t	bxNr () const
	get/set bunch cross number as counted in the GTFE board More...
const unsigned int	getSize () const
	get the size of the GTFE block in GT DAQ record (in multiple of 8 bits) More...
	L1GtfeWord ()
	constructors More...
	L1GtfeWord (cms_uint16_t boardIdValue, cms_uint16_t recordLength1Value, cms_uint16_t recordLengthValue, cms_uint16_t bxNrValue, cms_uint32_t setupVersionValue, cms_uint16_t activeBoardsValue, cms_uint16_t altNrBxBoardValue, cms_uint32_t totalTriggerNrValue)
	constructor from unpacked values; More...
bool	operator!= (const L1GtfeWord &) const
	unequal operator More...
bool	operator== (const L1GtfeWord &) const
	equal operator More...
const cms_uint16_t	recordLength () const
	get/set record length for alternative 0 More...
const cms_uint16_t	recordLength1 () const
	get/set record length for alternative 1 More...
void	setActiveBoards (cms_uint16_t activeBoardsValue)
void	setActiveBoards (const cms_uint64_t &word64)
void	setActiveBoardsWord64 (cms_uint64_t &word64, int iWord)
void	setActiveBoardsWord64 (cms_uint64_t &word64, int iWord, cms_int16_t activeBoardsValue)
void	setAltNrBxBoard (cms_uint16_t altNrBxBoardValue)
void	setAltNrBxBoard (const cms_uint64_t &word64)
void	setAltNrBxBoardWord64 (cms_uint64_t &word64, int iWord)
void	setAltNrBxBoardWord64 (cms_uint64_t &word64, int iWord, cms_int16_t altNrBxBoardValue)
void	setBoardId (cms_uint16_t boardIdValue)
	set BoardId from a BoardId value More...
void	setBoardId (const cms_uint64_t &word64)
	set the BoardId value from a 64-bits word More...
void	setBoardIdWord64 (cms_uint64_t &word64, int iWord)
void	setBstFlag (const int)
void	setBxNr (cms_uint16_t bxNrValue)
void	setBxNr (const cms_uint64_t &word64)
void	setBxNrWord64 (cms_uint64_t &word64, int iWord)
void	setRecordLength (cms_uint16_t recordLengthValue)
void	setRecordLength (const cms_uint64_t &word64)
void	setRecordLength1 (cms_uint16_t recordLengthValue)
void	setRecordLength1 (const cms_uint64_t &word64)
void	setRecordLength1Word64 (cms_uint64_t &word64, int iWord)
void	setRecordLengthWord64 (cms_uint64_t &word64, int iWord)
void	setSetupVersion (cms_uint32_t setupVersionValue)
void	setSetupVersion (const cms_uint64_t &word64)
void	setSetupVersionWord64 (cms_uint64_t &word64, int iWord)
void	setTotalTriggerNr (cms_uint32_t totalTriggerNrValue)
void	setTotalTriggerNr (const cms_uint64_t &word64)
void	setTotalTriggerNrWord64 (cms_uint64_t &word64, int iWord)
const cms_uint32_t	setupVersion () const
	get/set setup version More...
const cms_uint32_t	totalTriggerNr () const
	get/set total number of L1A sent since start of run More...
virtual	~L1GtfeWord ()
	destructor More...

Private Attributes
std::vector< cms_uint16_t >	m_bst
	BST message - each byte is an vector element. More...
cms_uint16_t	m_bstSource
	hex message indicating the source of BST message (beam or simulated) More...

Static Private Attributes
static const int	BeamModeFirstBlock = 26
static const int	BeamModeLastBlock = 27
static const int	BeamMomentumFirstBlock = 30
static const int	BeamMomentumLastBlock = 31
static const int	BstBitSize = 8
	size in bits for a BST block More...
static const cms_uint64_t	BstBlockMask = 0xFFULL
static const int	BstFirstWord = 2
	block description in the raw GT record More...
static const int	BstMasterStatusFirstBlock = 17
static const int	BstMasterStatusLastBlock = 17
static const cms_uint64_t	BstSourceMask = 0xFFFF000000000000ULL
static const int	BstSourceShift = 48
static const int	GpsTimeFirstBlock = 0
	BST blocks: conversion to defined quantities (LHC-BOB-ES-0001) More...
static const int	GpsTimeLastBlock = 7
static const int	LhcFillNumberFirstBlock = 22
static const int	LhcFillNumberLastBlock = 25
static const int	ParticleTypeBeam1FirstBlock = 28
static const int	ParticleTypeBeam1LastBlock = 28
static const int	ParticleTypeBeam2FirstBlock = 29
static const int	ParticleTypeBeam2LastBlock = 29
static const int	TotalIntensityBeam1FirstBlock = 32
static const int	TotalIntensityBeam1LastBlock = 35
static const int	TotalIntensityBeam2FirstBlock = 36
static const int	TotalIntensityBeam2LastBlock = 39
static const int	TurnCountNumberFirstBlock = 18
static const int	TurnCountNumberLastBlock = 21

Detailed Description

Description: L1 Global Trigger - extended GTFE block in the readout record.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

Description: L1 Global Trigger - GTFE words in the readout record.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

Definition at line 31 of file L1GtfeExtWord.h.

Constructor & Destructor Documentation

L1GtfeExtWord() [1/3]

L1GtfeExtWord::L1GtfeExtWord

(

)

constructors

Definition at line 34 of file L1GtfeExtWord.cc.

                             : L1GtfeWord(), m_bstSource(0) {
  // empty
}

L1GtfeExtWord() [2/3]

L1GtfeExtWord::L1GtfeExtWord

(

int

bstSizeBytes

)

all members set to zero, m_bst has bstSizeBytes zero elements

Definition at line 39 of file L1GtfeExtWord.cc.

References m_bst.

: L1GtfeWord(), m_bstSource(0) { m_bst.resize(bstSizeBytes); }

L1GtfeExtWord() [3/3]

L1GtfeExtWord::L1GtfeExtWord	(	cms_uint16_t	boardIdValue,
		cms_uint16_t	recordLengthValue,
		cms_uint16_t	recordLength1Value,
		cms_uint16_t	bxNrValue,
		cms_uint32_t	setupVersionValue,
		cms_uint16_t	activeBoardsValue,
		cms_uint16_t	altNrBxBoardValue,
		cms_uint32_t	totalTriggerNrValue,
		const std::vector< cms_uint16_t > &	bstValue,
		cms_uint16_t	bstSourceValue
	)

constructor from unpacked values, m_bst size taken from bstValue

Definition at line 42 of file L1GtfeExtWord.cc.

    : L1GtfeWord(boardIdValue,
                 recordLength1Value,
                 recordLengthValue,
                 bxNrValue,
                 setupVersionValue,
                 activeBoardsValue,
                 altNrBxBoardValue,
                 totalTriggerNrValue),
      m_bst(bstValue),
      m_bstSource(bstSourceValue)

{
  // empty
}

~L1GtfeExtWord()

L1GtfeExtWord::~L1GtfeExtWord ( )

override

destructor

Definition at line 68 of file L1GtfeExtWord.cc.

                              {
  // empty now
}

Member Function Documentation

beamMode()

const cms_uint16_t L1GtfeExtWord::beamMode

(

)

const

Definition at line 215 of file L1GtfeExtWord.cc.

References BeamModeFirstBlock, BeamModeLastBlock, BstBitSize, and m_bst.

Referenced by GenericTriggerEventFlag::acceptGtLogicalExpression(), SiStripMonitorDigi::analyze(), L1TGT::analyze(), L1TSync::analyze(), L1TSync_Offline::analyze(), L1TBPTX::analyze(), BeamSpotOnlineProducer::produce(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                 {
  cms_uint16_t bm = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (BeamModeLastBlock >= bstSize) {
    return bm;
  }

  for (int iB = BeamModeFirstBlock; iB <= BeamModeLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - BeamModeFirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    bm = bm | (m_bst[iB] << BstShift);
  }

  return bm;
}

beamMomentum()

const cms_uint16_t L1GtfeExtWord::beamMomentum

(

)

const

Definition at line 275 of file L1GtfeExtWord.cc.

References BeamMomentumFirstBlock, BeamMomentumLastBlock, BstBitSize, and m_bst.

Referenced by GenericTriggerEventFlag::acceptGtLogicalExpression(), L1TGT::analyze(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                     {
  cms_uint16_t bm = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (BeamMomentumLastBlock >= bstSize) {
    return bm;
  }

  for (int iB = BeamMomentumFirstBlock; iB <= BeamMomentumLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - BeamMomentumFirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    bm = bm | (m_bst[iB] << BstShift);
  }

  return bm;
}

bst() [1/2]

const std::vector<cms_uint16_t>& L1GtfeExtWord::bst ( ) const

inline

get the full BST block

Definition at line 62 of file L1GtfeExtWord.h.

References m_bst.

{ return m_bst; }

bst() [2/2]

const uint16_t L1GtfeExtWord::bst

(

int

iB

)

const

get/set BST block for index iB

Definition at line 336 of file L1GtfeExtWord.cc.

References Exception, and m_bst.

                                              {
  int NumberBstBlocks = m_bst.size();

  if (iB < 0 || iB >= NumberBstBlocks) {
    throw cms::Exception("BstIndexError")
        << "\nError: index for BST array out of range. Allowed range: [0, " << NumberBstBlocks << ") " << std::endl;

  } else {
    return m_bst[iB];
  }
}

bstLengthBytes()

const unsigned int L1GtfeExtWord::bstLengthBytes ( ) const

inline

get the size of the BST block

Definition at line 65 of file L1GtfeExtWord.h.

References m_bst.

Referenced by L1GTEvmDigiToRaw::produce().

{ return m_bst.size(); }

bstMasterStatus()

const cms_uint16_t L1GtfeExtWord::bstMasterStatus

(

)

const

Definition at line 155 of file L1GtfeExtWord.cc.

References BstBitSize, BstMasterStatusFirstBlock, BstMasterStatusLastBlock, and m_bst.

Referenced by L1TGT::analyze(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                        {
  cms_uint16_t bms = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (BstMasterStatusLastBlock >= bstSize) {
    return bms;
  }

  for (int iB = BstMasterStatusFirstBlock; iB <= BstMasterStatusLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - BstMasterStatusFirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    bms = bms | (m_bst[iB] << BstShift);
  }

  return bms;
}

bstSource()

const cms_uint16_t L1GtfeExtWord::bstSource ( ) const

inline

get/set hex message indicating the source of BST message

Definition at line 96 of file L1GtfeExtWord.h.

References m_bstSource.

{ return m_bstSource; }

getSize()

const unsigned int L1GtfeExtWord::getSize

(

)

const

get the size of the GTFE block in GT EVM record (in multiple of 8 bits)

Definition at line 402 of file L1GtfeExtWord.cc.

References L1GtfeWord::getSize(), and m_bst.

Referenced by L1GTEvmDigiToRaw::packGTFE(), L1GTEvmDigiToRaw::produce(), L1GlobalTriggerEvmRawToDigi::produce(), setBstSourceWord64(), and unpack().

                                                {
  L1GtfeWord gtfeWord;
  unsigned int gtfeSize = gtfeWord.getSize();

  unsigned int gtfeExtSize;

  // 2 bytes to write if real BST message or simulated BST message
  unsigned int bytesBstWriter = 2;

  // size of BST block, using rounded 64-bit words (8 bytes per 64-bit word)

  unsigned int bstSize = m_bst.size();

  if ((bstSize + bytesBstWriter) % 8 == 0) {
    gtfeExtSize = gtfeSize + bstSize + bytesBstWriter;
  } else {
    gtfeExtSize = gtfeSize + bstSize + bytesBstWriter + (8 - (bstSize + bytesBstWriter) % 8);
  }

  return gtfeExtSize;
}

gpsTime()

const cms_uint64_t L1GtfeExtWord::gpsTime

(

)

const

LHC-BOB-ES-0001 (EDMS 638899)

Definition at line 104 of file L1GtfeExtWord.cc.

References BstBitSize, GpsTimeFirstBlock, GpsTimeLastBlock, and m_bst.

Referenced by L1TGT::analyze(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                {
  cms_uint64_t gpst = 0ULL;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (GpsTimeLastBlock >= bstSize) {
    return gpst;
  }

  for (int iB = GpsTimeFirstBlock; iB <= GpsTimeLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - GpsTimeFirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    gpst = gpst | ((static_cast<cms_uint64_t>(m_bst[iB])) << BstShift);
  }

  return gpst;
}

lhcFillNumber()

const cms_uint32_t L1GtfeExtWord::lhcFillNumber

(

)

const

Definition at line 195 of file L1GtfeExtWord.cc.

References BstBitSize, LhcFillNumberFirstBlock, LhcFillNumberLastBlock, and m_bst.

Referenced by L1TGT::analyze(), L1TSync::analyze(), L1TSync_Offline::analyze(), L1TBPTX::analyze(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                      {
  cms_uint32_t lhcfn = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (LhcFillNumberLastBlock >= bstSize) {
    return lhcfn;
  }

  for (int iB = LhcFillNumberFirstBlock; iB <= LhcFillNumberLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - LhcFillNumberFirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    lhcfn = lhcfn | ((static_cast<cms_uint32_t>(m_bst[iB])) << BstShift);
  }

  return lhcfn;
}

operator!=()

bool L1GtfeExtWord::operator!=

(

const L1GtfeExtWord &

result

)

const

unequal operator

Definition at line 100 of file L1GtfeExtWord.cc.

References mps_fire::result.

{ return !(result == *this); }

operator==()

bool L1GtfeExtWord::operator==

(

const L1GtfeExtWord &

result

)

const

equal operator

Definition at line 73 of file L1GtfeExtWord.cc.

References m_bst, m_bstSource, and mps_fire::result.

                                                                {
  // base class

  const L1GtfeWord gtfeResult = result;
  const L1GtfeWord gtfeThis = *this;

  if (gtfeThis != gtfeResult) {
    return false;
  }

  //

  for (unsigned int iB = 0; iB < m_bst.size(); ++iB) {
    if (m_bst[iB] != result.m_bst[iB]) {
      return false;
    }
  }

  if (m_bstSource != result.m_bstSource) {
    return false;
  }

  // all members identical
  return true;
}

particleTypeBeam1()

const cms_uint16_t L1GtfeExtWord::particleTypeBeam1

(

)

const

Definition at line 235 of file L1GtfeExtWord.cc.

References BstBitSize, m_bst, ParticleTypeBeam1FirstBlock, and ParticleTypeBeam1LastBlock.

Referenced by L1Analysis::L1AnalysisGT::SetEvm().

                                                          {
  cms_uint16_t ptb = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (ParticleTypeBeam1LastBlock >= bstSize) {
    return ptb;
  }

  for (int iB = ParticleTypeBeam1FirstBlock; iB <= ParticleTypeBeam1LastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - ParticleTypeBeam1FirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    ptb = ptb | (m_bst[iB] << BstShift);
  }

  return ptb;
}

particleTypeBeam2()

const cms_uint16_t L1GtfeExtWord::particleTypeBeam2

(

)

const

Definition at line 255 of file L1GtfeExtWord.cc.

References BstBitSize, m_bst, ParticleTypeBeam2FirstBlock, and ParticleTypeBeam2LastBlock.

Referenced by L1Analysis::L1AnalysisGT::SetEvm().

                                                          {
  cms_uint16_t ptb = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (ParticleTypeBeam2LastBlock >= bstSize) {
    return ptb;
  }

  for (int iB = ParticleTypeBeam2FirstBlock; iB <= ParticleTypeBeam2LastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - ParticleTypeBeam2FirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    ptb = ptb | (m_bst[iB] << BstShift);
  }

  return ptb;
}

print()

void L1GtfeExtWord::print ( std::ostream &  myCout ) const

overridevirtual

pretty print the content of a L1GtfeExtWord

Reimplemented from L1GtfeWord.

Definition at line 434 of file L1GtfeExtWord.cc.

References TauDecayModes::dec, m_bst, m_bstSource, and L1GtfeWord::print().

Referenced by L1GlobalTriggerEvmReadoutRecord::print(), L1GTEvmDigiToRaw::produce(), and L1GlobalTriggerEvmRawToDigi::produce().

                                                  {
  myCout << "\n L1GtfeExtWord::print \n" << std::endl;

  unsigned int sizeW64 = 64;
  unsigned int dataBlocksPerLine = sizeW64 / 8;  // 8x8 bits per line

  L1GtfeWord::print(myCout);

  unsigned int numberBstBlocks = m_bst.size();

  myCout << "\n  BST ";

  if (numberBstBlocks == 0) {
    myCout << "\n  BST source [hex]: " << std::hex << std::setw(4) << std::setfill('0') << m_bstSource
           << std::setfill(' ') << std::dec << std::endl;

    return;
  }

  for (unsigned int iB = 0; iB < numberBstBlocks; iB += dataBlocksPerLine) {
    myCout << "\n" << std::hex << " hex: ";

    for (unsigned int jB = iB; jB < dataBlocksPerLine + iB; ++jB) {
      if (jB >= numberBstBlocks) {
        break;
      }

      myCout << std::setw(2) << std::setfill('0') << m_bst[jB] << "   " << std::setfill(' ');
    }

    myCout << "\n" << std::dec << " dec: ";

    for (unsigned int jB = iB; jB < dataBlocksPerLine + iB; ++jB) {
      if (jB >= numberBstBlocks) {
        break;
      }

      myCout << std::setw(3) << std::setfill('0') << m_bst[jB] << "  " << std::setfill(' ');
    }

    myCout << std::endl;
  }

  myCout << "\n  BST source [hex]: " << std::hex << std::setw(4) << std::setfill('0') << m_bstSource
         << std::setfill(' ') << std::dec << std::endl;
}

reset()

void L1GtfeExtWord::reset ( void  )

overridevirtual

reset the content of a L1GtfeExtWord

Reimplemented from L1GtfeWord.

Definition at line 428 of file L1GtfeExtWord.cc.

References m_bst, and L1GtfeWord::reset().

Referenced by L1GlobalTriggerEvmRawToDigi::produce().

                          {
  L1GtfeWord::reset();
  m_bst.clear();
}

resize()

void L1GtfeExtWord::resize

(

int

bstSizeBytes

)

resize the BST vector to get the right size of the block

Definition at line 425 of file L1GtfeExtWord.cc.

References m_bst.

Referenced by L1GlobalTriggerEvmRawToDigi::produce().

{ m_bst.resize(bstSizeBytes); }

setBst() [1/2]

void L1GtfeExtWord::setBst	(	const cms_uint16_t	bstVal,
		const int	iB
	)

Referenced by unpack().

setBst() [2/2]

void L1GtfeExtWord::setBst	(	const cms_uint64_t &	word64,
		const int	iB
	)

set the BST block for index iB from a 64-bits word

Definition at line 361 of file L1GtfeExtWord.cc.

References BstBitSize, BstBlockMask, and m_bst.

                                                                   {
  // keep capitalization for similarity with other functions //FIXME check it again
  const int scaledIB = iB % (sizeof(word64) * 8 / BstBitSize);
  const int BstShift = BstBitSize * scaledIB;
  const cms_uint64_t BstMask = 0x0000000000000000ULL | (BstBlockMask << BstShift);

  m_bst[iB] = static_cast<cms_uint16_t>((word64 & BstMask) >> BstShift);
}

setBstSource() [1/2]

void L1GtfeExtWord::setBstSource ( const cms_uint16_t  bstSourceVal )

inline

Definition at line 98 of file L1GtfeExtWord.h.

References m_bstSource.

Referenced by L1GlobalTrigger::produce().

{ m_bstSource = bstSourceVal; }

setBstSource() [2/2]

void L1GtfeExtWord::setBstSource

(

const cms_uint64_t &

word64

)

set the hex message indicating the source of BST message from a 64-bits word

Definition at line 384 of file L1GtfeExtWord.cc.

References BstSourceMask, BstSourceShift, and m_bstSource.

                                                           {
  m_bstSource = (word64 & BstSourceMask) >> BstSourceShift;
}

setBstSourceWord64()

void L1GtfeExtWord::setBstSourceWord64	(	cms_uint64_t &	word64,
		const int	iWord
	)

set hex message indicating the source of BST message in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 390 of file L1GtfeExtWord.cc.

References BstSourceShift, getSize(), and m_bstSource.

                                                                            {
  // BST always in the last word of GTFE extended - size must be correct!
  int gtfeSize = this->getSize();

  int BstSourceWord = gtfeSize / 8 - 1;  // counting starts at 0

  if (iWord == BstSourceWord) {
    word64 = word64 | (static_cast<cms_uint64_t>(m_bstSource) << BstSourceShift);
  }
}

setBstWord64()

void L1GtfeExtWord::setBstWord64	(	cms_uint64_t &	word64,
		int	iB,
		const int	iWord
	)

set the BST block in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 372 of file L1GtfeExtWord.cc.

References BstBitSize, BstFirstWord, and m_bst.

Referenced by L1GTEvmDigiToRaw::packGTFE().

                                                                        {
  // keep capitalization for similarity with other functions
  const int scaledIB = iB % (sizeof(word64) * 8 / BstBitSize);
  const int BstShift = BstBitSize * scaledIB;
  const int BstWord = iB / (sizeof(word64) * 8 / BstBitSize) + BstFirstWord;

  if (iWord == BstWord) {
    word64 = word64 | (static_cast<cms_uint64_t>(m_bst[iB]) << BstShift);
  }
}

setGpsTime()

void L1GtfeExtWord::setGpsTime

(

const cms_uint64_t

gpsTimeValue

)

Definition at line 124 of file L1GtfeExtWord.cc.

References BstBitSize, BstBlockMask, GpsTimeFirstBlock, GpsTimeLastBlock, and m_bst.

Referenced by L1GlobalTrigger::produce().

                                                              {
  // return if BST message too small
  int bstSize = m_bst.size();
  if (GpsTimeLastBlock >= bstSize) {
    edm::LogError("L1GtfeExtWord") << "Error: BST message length " << bstSize
                                   << " smaller than the required GpsTimeLastBlock " << GpsTimeLastBlock
                                   << "\n Cannot set GpsTime" << std::endl;

    return;
  }

  for (int iB = GpsTimeFirstBlock; iB <= GpsTimeLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - GpsTimeFirstBlock;
    const int BstShift = BstBitSize * scaledIB;
    const cms_uint64_t BstMask = 0x0000000000000000ULL | (BstBlockMask << BstShift);

    m_bst[iB] = static_cast<cms_uint16_t>((gpsTimeValue & BstMask) >> BstShift);

    //LogTrace("L1GtfeExtWord")
    //<< "BstShift: value [dec] = " << BstShift << "\n"
    //<< "BstBlockMask: value [hex] = "  << std::hex << BstBlockMask << "\n"
    //<< "BstMask: value [hex] = "<< BstMask << std::dec
    //<< std::endl;

    //LogTrace("L1GtfeExtWord")
    //<< "BST block " << iB << ": value [hex] = " << std::hex << m_bst[iB] << std::dec
    //<< std::endl;
  }
}

totalIntensityBeam1()

const cms_uint32_t L1GtfeExtWord::totalIntensityBeam1

(

)

const

Definition at line 295 of file L1GtfeExtWord.cc.

References BstBitSize, m_bst, TotalIntensityBeam1FirstBlock, and TotalIntensityBeam1LastBlock.

Referenced by L1TGT::analyze(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                            {
  cms_uint32_t tib = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (TotalIntensityBeam1LastBlock >= bstSize) {
    return tib;
  }

  for (int iB = TotalIntensityBeam1FirstBlock; iB <= TotalIntensityBeam1LastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - TotalIntensityBeam1FirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    tib = tib | ((static_cast<cms_uint32_t>(m_bst[iB])) << BstShift);
  }

  return tib;
}

totalIntensityBeam2()

const cms_uint32_t L1GtfeExtWord::totalIntensityBeam2

(

)

const

Definition at line 315 of file L1GtfeExtWord.cc.

References BstBitSize, m_bst, TotalIntensityBeam2FirstBlock, and TotalIntensityBeam2LastBlock.

Referenced by L1TGT::analyze(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                            {
  cms_uint32_t tib = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (TotalIntensityBeam2LastBlock >= bstSize) {
    return tib;
  }

  for (int iB = TotalIntensityBeam2FirstBlock; iB <= TotalIntensityBeam2LastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - TotalIntensityBeam2FirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    tib = tib | ((static_cast<cms_uint32_t>(m_bst[iB])) << BstShift);
  }

  return tib;
}

turnCountNumber()

const cms_uint32_t L1GtfeExtWord::turnCountNumber

(

)

const

Definition at line 175 of file L1GtfeExtWord.cc.

References BstBitSize, m_bst, TurnCountNumberFirstBlock, and TurnCountNumberLastBlock.

Referenced by L1TGT::analyze(), ConditionDumperInEdm::produce(), and L1Analysis::L1AnalysisGT::SetEvm().

                                                        {
  cms_uint32_t tcn = 0;

  // return 0 if BST message too small
  int bstSize = m_bst.size();
  if (TurnCountNumberLastBlock >= bstSize) {
    return tcn;
  }

  for (int iB = TurnCountNumberFirstBlock; iB <= TurnCountNumberLastBlock; ++iB) {
    // keep capitalization for similarity with other functions
    const int scaledIB = iB - TurnCountNumberFirstBlock;
    const int BstShift = BstBitSize * scaledIB;

    tcn = tcn | ((static_cast<cms_uint32_t>(m_bst[iB])) << BstShift);
  }

  return tcn;
}

unpack()

void L1GtfeExtWord::unpack ( const unsigned char *  gtfePtr )

overridevirtual

unpack GTFE gtfePtr pointer to the beginning of the GTFE block in the raw data

Reimplemented from L1GtfeWord.

Definition at line 481 of file L1GtfeExtWord.cc.

References BstBitSize, BstFirstWord, runTheMatrix::const, TauDecayModes::dec, getSize(), L1GtfeWord::getSize(), edm::isDebugEnabled(), LogDebug, LogTrace, m_bst, jetsAK4_Puppi_cff::payload, setBst(), and L1GtfeWord::unpack().

Referenced by L1GlobalTriggerEvmRawToDigi::produce().

                                                       {
  LogDebug("L1GtfeExtWord") << "\nUnpacking GTFE block.\n" << std::endl;

  L1GtfeWord::unpack(gtfePtr);

  // TODO make BlockSize protected & use friends instead of creating L1GtfeWord?
  L1GtfeWord gtfeWord;
  const unsigned char* gtfeExtPtr = gtfePtr + gtfeWord.getSize();

  const cms_uint64_t* payload = reinterpret_cast<cms_uint64_t const*>(gtfeExtPtr);

  int BlockSizeExt = this->getSize() / 8;
  int NumberBstBlocks = m_bst.size();

  if (edm::isDebugEnabled()) {
    for (int iWord = BstFirstWord; iWord < BlockSizeExt; ++iWord) {
      int jWord = iWord - BstFirstWord;
      LogTrace("L1GtfeExtWord") << std::setw(4) << iWord << "  " << std::hex << std::setfill('0') << std::setw(16)
                                << payload[jWord] << std::dec << std::setfill(' ') << std::endl;
    }
  }

  int blocksPerWord = sizeof(cms_uint64_t) * 8 / BstBitSize;

  for (int iB = 0; iB < NumberBstBlocks; ++iB) {
    // keep capitalization for similarity with other functions
    int BstWord = iB / blocksPerWord;

    setBst(payload[BstWord], iB);
  }
}

Member Data Documentation

BeamModeFirstBlock

const int L1GtfeExtWord::BeamModeFirstBlock = 26

staticprivate

Definition at line 152 of file L1GtfeExtWord.h.

Referenced by beamMode().

BeamModeLastBlock

const int L1GtfeExtWord::BeamModeLastBlock = 27

staticprivate

Definition at line 153 of file L1GtfeExtWord.h.

Referenced by beamMode().

BeamMomentumFirstBlock

const int L1GtfeExtWord::BeamMomentumFirstBlock = 30

staticprivate

Definition at line 161 of file L1GtfeExtWord.h.

Referenced by beamMomentum().

BeamMomentumLastBlock

const int L1GtfeExtWord::BeamMomentumLastBlock = 31

staticprivate

Definition at line 162 of file L1GtfeExtWord.h.

Referenced by beamMomentum().

BstBitSize

const int L1GtfeExtWord::BstBitSize = 8

staticprivate

size in bits for a BST block

Definition at line 132 of file L1GtfeExtWord.h.

Referenced by beamMode(), beamMomentum(), bstMasterStatus(), gpsTime(), lhcFillNumber(), particleTypeBeam1(), particleTypeBeam2(), setBst(), setBstWord64(), setGpsTime(), totalIntensityBeam1(), totalIntensityBeam2(), turnCountNumber(), and unpack().

BstBlockMask

const cms_uint64_t L1GtfeExtWord::BstBlockMask = 0xFFULL

staticprivate

BST block mask, correlated with the number of bits of a block 8 bit = 0xFF

Definition at line 136 of file L1GtfeExtWord.h.

Referenced by setBst(), and setGpsTime().

BstFirstWord

const int L1GtfeExtWord::BstFirstWord = 2

staticprivate

block description in the raw GT record

index of first word for BST blocks

Definition at line 129 of file L1GtfeExtWord.h.

Referenced by setBstWord64(), and unpack().

BstMasterStatusFirstBlock

const int L1GtfeExtWord::BstMasterStatusFirstBlock = 17

staticprivate

Definition at line 143 of file L1GtfeExtWord.h.

Referenced by bstMasterStatus().

BstMasterStatusLastBlock

const int L1GtfeExtWord::BstMasterStatusLastBlock = 17

staticprivate

Definition at line 144 of file L1GtfeExtWord.h.

Referenced by bstMasterStatus().

BstSourceMask

const cms_uint64_t L1GtfeExtWord::BstSourceMask = 0xFFFF000000000000ULL

staticprivate

Definition at line 171 of file L1GtfeExtWord.h.

Referenced by setBstSource().

BstSourceShift

const int L1GtfeExtWord::BstSourceShift = 48

staticprivate

Definition at line 173 of file L1GtfeExtWord.h.

Referenced by setBstSource(), and setBstSourceWord64().

GpsTimeFirstBlock

const int L1GtfeExtWord::GpsTimeFirstBlock = 0

staticprivate

BST blocks: conversion to defined quantities (LHC-BOB-ES-0001)

Definition at line 140 of file L1GtfeExtWord.h.

Referenced by gpsTime(), and setGpsTime().

GpsTimeLastBlock

const int L1GtfeExtWord::GpsTimeLastBlock = 7

staticprivate

Definition at line 141 of file L1GtfeExtWord.h.

Referenced by gpsTime(), and setGpsTime().

LhcFillNumberFirstBlock

const int L1GtfeExtWord::LhcFillNumberFirstBlock = 22

staticprivate

Definition at line 149 of file L1GtfeExtWord.h.

Referenced by lhcFillNumber().

LhcFillNumberLastBlock

const int L1GtfeExtWord::LhcFillNumberLastBlock = 25

staticprivate

Definition at line 150 of file L1GtfeExtWord.h.

Referenced by lhcFillNumber().

m_bst

std::vector<cms_uint16_t> L1GtfeExtWord::m_bst

private

BST message - each byte is an vector element.

Definition at line 177 of file L1GtfeExtWord.h.

Referenced by beamMode(), beamMomentum(), bst(), bstLengthBytes(), bstMasterStatus(), getSize(), gpsTime(), L1GtfeExtWord(), lhcFillNumber(), operator==(), particleTypeBeam1(), particleTypeBeam2(), print(), reset(), resize(), setBst(), setBstWord64(), setGpsTime(), totalIntensityBeam1(), totalIntensityBeam2(), turnCountNumber(), and unpack().

m_bstSource

cms_uint16_t L1GtfeExtWord::m_bstSource

private

hex message indicating the source of BST message (beam or simulated)

Definition at line 180 of file L1GtfeExtWord.h.

Referenced by bstSource(), operator==(), print(), setBstSource(), and setBstSourceWord64().

ParticleTypeBeam1FirstBlock

const int L1GtfeExtWord::ParticleTypeBeam1FirstBlock = 28

staticprivate

Definition at line 155 of file L1GtfeExtWord.h.

Referenced by particleTypeBeam1().

ParticleTypeBeam1LastBlock

const int L1GtfeExtWord::ParticleTypeBeam1LastBlock = 28

staticprivate

Definition at line 156 of file L1GtfeExtWord.h.

Referenced by particleTypeBeam1().

ParticleTypeBeam2FirstBlock

const int L1GtfeExtWord::ParticleTypeBeam2FirstBlock = 29

staticprivate

Definition at line 158 of file L1GtfeExtWord.h.

Referenced by particleTypeBeam2().

ParticleTypeBeam2LastBlock

const int L1GtfeExtWord::ParticleTypeBeam2LastBlock = 29

staticprivate

Definition at line 159 of file L1GtfeExtWord.h.

Referenced by particleTypeBeam2().

TotalIntensityBeam1FirstBlock

const int L1GtfeExtWord::TotalIntensityBeam1FirstBlock = 32

staticprivate

Definition at line 164 of file L1GtfeExtWord.h.

Referenced by totalIntensityBeam1().

TotalIntensityBeam1LastBlock

const int L1GtfeExtWord::TotalIntensityBeam1LastBlock = 35

staticprivate

Definition at line 165 of file L1GtfeExtWord.h.

Referenced by totalIntensityBeam1().

TotalIntensityBeam2FirstBlock

const int L1GtfeExtWord::TotalIntensityBeam2FirstBlock = 36

staticprivate

Definition at line 167 of file L1GtfeExtWord.h.

Referenced by totalIntensityBeam2().

TotalIntensityBeam2LastBlock

const int L1GtfeExtWord::TotalIntensityBeam2LastBlock = 39

staticprivate

Definition at line 168 of file L1GtfeExtWord.h.

Referenced by totalIntensityBeam2().

TurnCountNumberFirstBlock

const int L1GtfeExtWord::TurnCountNumberFirstBlock = 18

staticprivate

Definition at line 146 of file L1GtfeExtWord.h.

Referenced by turnCountNumber().

TurnCountNumberLastBlock

const int L1GtfeExtWord::TurnCountNumberLastBlock = 21

staticprivate

Definition at line 147 of file L1GtfeExtWord.h.

Referenced by turnCountNumber().