CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Attributes | Static Private Attributes
L1GtfeWord Class Reference

#include <L1GtfeWord.h>

Inheritance diagram for L1GtfeWord:
L1GtfeExtWord

Public Member Functions

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...
 
virtual void print (std::ostream &myCout) const
 pretty print the content of a L1GtfeWord 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...
 
virtual void reset ()
 reset the content of a L1GtfeWord 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 void unpack (const unsigned char *gtfePtr)
 
virtual ~L1GtfeWord ()
 destructor More...
 

Private Attributes

cms_uint16_t m_activeBoards
 active boards contributing to EVM respectively DAQ record More...
 
cms_uint16_t m_altNrBxBoard
 
cms_uint16_t m_boardId
 board identifier More...
 
cms_uint16_t m_bxNr
 bunch cross number as counted in the GTFE board More...
 
cms_uint16_t m_recordLength
 record length for alternative 0 More...
 
cms_uint16_t m_recordLength1
 record length for alternative 1 More...
 
cms_uint32_t m_setupVersion
 
cms_uint32_t m_totalTriggerNr
 total number of L1A sent since start of run More...
 

Static Private Attributes

static const cms_uint64_t ActiveBoardsMask = 0xFFFF000000000000ULL
 
static const int ActiveBoardsShift = 48
 
static const int ActiveBoardsWord = 1
 
static const cms_uint64_t AltNrBxBoardMask = 0x0000FFFF00000000ULL
 
static const int AltNrBxBoardShift = 32
 
static const int AltNrBxBoardWord = 1
 
static const int BlockSize = 2
 
static const cms_uint64_t BoardIdMask = 0xFF00000000000000ULL
 
static const int BoardIdShift = 56
 
static const int BoardIdWord = 0
 
static const cms_uint32_t BstFlagMask = 0x0001
 
static const cms_uint64_t BxNrMask = 0x00000FFF00000000ULL
 
static const int BxNrShift = 32
 
static const int BxNrWord = 0
 
static const cms_uint64_t RecordLength1Mask = 0x00F0000000000000ULL
 
static const int RecordLength1Shift = 52
 
static const int RecordLength1Word = 0
 
static const cms_uint64_t RecordLengthMask = 0x000F000000000000ULL
 
static const int RecordLengthShift = 48
 
static const int RecordLengthWord = 0
 
static const cms_uint64_t SetupVersionMask = 0x00000000FFFFFFFFULL
 
static const int SetupVersionShift = 0
 
static const int SetupVersionWord = 0
 
static const cms_uint64_t TotalTriggerNrMask = 0x00000000FFFFFFFFULL
 
static const int TotalTriggerNrShift = 0
 
static const int TotalTriggerNrWord = 1
 

Detailed Description

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

Implementation: <TODO: enter implementation details>

Author
: Vasile Mihai Ghete - HEPHY Vienna

Definition at line 30 of file L1GtfeWord.h.

Constructor & Destructor Documentation

L1GtfeWord::L1GtfeWord ( )

constructors

Definition at line 29 of file L1GtfeWord.cc.

L1GtfeWord::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;

Definition at line 38 of file L1GtfeWord.cc.

L1GtfeWord::~L1GtfeWord ( )
virtual

destructor

Definition at line 54 of file L1GtfeWord.cc.

Member Function Documentation

const cms_uint16_t L1GtfeWord::activeBoards ( ) const
inline

get/set boards contributing to EVM respectively DAQ record

Definition at line 163 of file L1GtfeWord.h.

const cms_uint16_t L1GtfeWord::altNrBxBoard ( ) const
inline

get/set alternative for number of BX per board

Definition at line 187 of file L1GtfeWord.h.

const cms_uint16_t L1GtfeWord::boardId ( ) const
inline

get/set board ID

get BoardId value

Definition at line 65 of file L1GtfeWord.h.

const int L1GtfeWord::bstFlag ( ) const

get / set BST flag: 0 or 1 - via setup version (no private member)

Definition at line 206 of file L1GtfeWord.cc.

const cms_uint16_t L1GtfeWord::bxNr ( ) const
inline

get/set bunch cross number as counted in the GTFE board

Definition at line 122 of file L1GtfeWord.h.

const unsigned int L1GtfeWord::getSize ( ) const
inline

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

Definition at line 229 of file L1GtfeWord.h.

bool L1GtfeWord::operator!= ( const L1GtfeWord &  result) const

unequal operator

Definition at line 103 of file L1GtfeWord.cc.

bool L1GtfeWord::operator== ( const L1GtfeWord &  result) const

equal operator

Definition at line 62 of file L1GtfeWord.cc.

void L1GtfeWord::print ( std::ostream &  myCout) const
virtual

pretty print the content of a L1GtfeWord

Reimplemented in L1GtfeExtWord.

Definition at line 321 of file L1GtfeWord.cc.

const cms_uint16_t L1GtfeWord::recordLength ( ) const
inline

get/set record length for alternative 0

Definition at line 104 of file L1GtfeWord.h.

const cms_uint16_t L1GtfeWord::recordLength1 ( ) const
inline

get/set record length for alternative 1

Definition at line 85 of file L1GtfeWord.h.

void L1GtfeWord::reset ( void  )
virtual

reset the content of a L1GtfeWord

Reimplemented in L1GtfeExtWord.

Definition at line 306 of file L1GtfeWord.cc.

void L1GtfeWord::setActiveBoards ( cms_uint16_t  activeBoardsValue)
inline

Definition at line 168 of file L1GtfeWord.h.

void L1GtfeWord::setActiveBoards ( const cms_uint64_t &  word64)

Definition at line 224 of file L1GtfeWord.cc.

void L1GtfeWord::setActiveBoardsWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the ActiveBoards value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 231 of file L1GtfeWord.cc.

void L1GtfeWord::setActiveBoardsWord64 ( cms_uint64_t &  word64,
int  iWord,
cms_int16_t  activeBoardsValue 
)

set the ActiveBoards value in a 64-bits word, having the index iWord in the GTFE raw record from the value activeBoardsValue

Definition at line 243 of file L1GtfeWord.cc.

void L1GtfeWord::setAltNrBxBoard ( cms_uint16_t  altNrBxBoardValue)
inline

Definition at line 192 of file L1GtfeWord.h.

void L1GtfeWord::setAltNrBxBoard ( const cms_uint64_t &  word64)

Definition at line 256 of file L1GtfeWord.cc.

void L1GtfeWord::setAltNrBxBoardWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the AltNrBxBoard value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 263 of file L1GtfeWord.cc.

void L1GtfeWord::setAltNrBxBoardWord64 ( cms_uint64_t &  word64,
int  iWord,
cms_int16_t  altNrBxBoardValue 
)

set the AltNrBxBoard value in a 64-bits word, having the index iWord in the GTFE raw record from the value altNrBxBoardValue

Definition at line 275 of file L1GtfeWord.cc.

void L1GtfeWord::setBoardId ( cms_uint16_t  boardIdValue)
inline

set BoardId from a BoardId value

Definition at line 71 of file L1GtfeWord.h.

void L1GtfeWord::setBoardId ( const cms_uint64_t &  word64)

set the BoardId value from a 64-bits word

Definition at line 113 of file L1GtfeWord.cc.

void L1GtfeWord::setBoardIdWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the BoardId value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 120 of file L1GtfeWord.cc.

void L1GtfeWord::setBstFlag ( const int  bstFlagValue)

Definition at line 215 of file L1GtfeWord.cc.

void L1GtfeWord::setBxNr ( cms_uint16_t  bxNrValue)
inline

Definition at line 127 of file L1GtfeWord.h.

void L1GtfeWord::setBxNr ( const cms_uint64_t &  word64)

Definition at line 169 of file L1GtfeWord.cc.

void L1GtfeWord::setBxNrWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the BxNr value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 176 of file L1GtfeWord.cc.

void L1GtfeWord::setRecordLength ( cms_uint16_t  recordLengthValue)
inline

Definition at line 109 of file L1GtfeWord.h.

void L1GtfeWord::setRecordLength ( const cms_uint64_t &  word64)

Definition at line 150 of file L1GtfeWord.cc.

void L1GtfeWord::setRecordLength1 ( cms_uint16_t  recordLengthValue)
inline

Definition at line 90 of file L1GtfeWord.h.

void L1GtfeWord::setRecordLength1 ( const cms_uint64_t &  word64)

Definition at line 131 of file L1GtfeWord.cc.

void L1GtfeWord::setRecordLength1Word64 ( cms_uint64_t &  word64,
int  iWord 
)

set the RecordLength value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 138 of file L1GtfeWord.cc.

void L1GtfeWord::setRecordLengthWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the RecordLength value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 157 of file L1GtfeWord.cc.

void L1GtfeWord::setSetupVersion ( cms_uint32_t  setupVersionValue)
inline

Definition at line 145 of file L1GtfeWord.h.

void L1GtfeWord::setSetupVersion ( const cms_uint64_t &  word64)

Definition at line 187 of file L1GtfeWord.cc.

void L1GtfeWord::setSetupVersionWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the SetupVersion value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 194 of file L1GtfeWord.cc.

void L1GtfeWord::setTotalTriggerNr ( cms_uint32_t  totalTriggerNrValue)
inline

Definition at line 216 of file L1GtfeWord.h.

void L1GtfeWord::setTotalTriggerNr ( const cms_uint64_t &  word64)

Definition at line 286 of file L1GtfeWord.cc.

void L1GtfeWord::setTotalTriggerNrWord64 ( cms_uint64_t &  word64,
int  iWord 
)

set the TotalTriggerNr value in a 64-bits word, having the index iWord in the GTFE raw record

Definition at line 293 of file L1GtfeWord.cc.

const cms_uint32_t L1GtfeWord::setupVersion ( ) const
inline

get/set setup version

Definition at line 140 of file L1GtfeWord.h.

const cms_uint32_t L1GtfeWord::totalTriggerNr ( ) const
inline

get/set total number of L1A sent since start of run

Definition at line 211 of file L1GtfeWord.h.

void L1GtfeWord::unpack ( const unsigned char *  gtfePtr)
virtual

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

Reimplemented in L1GtfeExtWord.

Definition at line 380 of file L1GtfeWord.cc.

Member Data Documentation

const cms_uint64_t L1GtfeWord::ActiveBoardsMask = 0xFFFF000000000000ULL
staticprivate

Definition at line 281 of file L1GtfeWord.h.

const int L1GtfeWord::ActiveBoardsShift = 48
staticprivate

Definition at line 285 of file L1GtfeWord.h.

const int L1GtfeWord::ActiveBoardsWord = 1
staticprivate

Definition at line 277 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::AltNrBxBoardMask = 0x0000FFFF00000000ULL
staticprivate

Definition at line 282 of file L1GtfeWord.h.

const int L1GtfeWord::AltNrBxBoardShift = 32
staticprivate

Definition at line 286 of file L1GtfeWord.h.

const int L1GtfeWord::AltNrBxBoardWord = 1
staticprivate

Definition at line 278 of file L1GtfeWord.h.

const int L1GtfeWord::BlockSize = 2
staticprivate

Definition at line 253 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::BoardIdMask = 0xFF00000000000000ULL
staticprivate

Definition at line 261 of file L1GtfeWord.h.

const int L1GtfeWord::BoardIdShift = 56
staticprivate

Definition at line 270 of file L1GtfeWord.h.

const int L1GtfeWord::BoardIdWord = 0
staticprivate

Definition at line 255 of file L1GtfeWord.h.

const cms_uint32_t L1GtfeWord::BstFlagMask = 0x0001
staticprivate

Definition at line 267 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::BxNrMask = 0x00000FFF00000000ULL
staticprivate

Definition at line 264 of file L1GtfeWord.h.

const int L1GtfeWord::BxNrShift = 32
staticprivate

Definition at line 273 of file L1GtfeWord.h.

const int L1GtfeWord::BxNrWord = 0
staticprivate

Definition at line 258 of file L1GtfeWord.h.

cms_uint16_t L1GtfeWord::m_activeBoards
private

active boards contributing to EVM respectively DAQ record

Definition at line 306 of file L1GtfeWord.h.

cms_uint16_t L1GtfeWord::m_altNrBxBoard
private

alternative for number of BX per board correlated with active boards bit value is 0: take alternative 0 bit value is 1: take alternative 1

Definition at line 312 of file L1GtfeWord.h.

cms_uint16_t L1GtfeWord::m_boardId
private

board identifier

Definition at line 293 of file L1GtfeWord.h.

cms_uint16_t L1GtfeWord::m_bxNr
private

bunch cross number as counted in the GTFE board

Definition at line 302 of file L1GtfeWord.h.

cms_uint16_t L1GtfeWord::m_recordLength
private

record length for alternative 0

Definition at line 299 of file L1GtfeWord.h.

cms_uint16_t L1GtfeWord::m_recordLength1
private

record length for alternative 1

Definition at line 296 of file L1GtfeWord.h.

cms_uint32_t L1GtfeWord::m_setupVersion
private

Definition at line 303 of file L1GtfeWord.h.

cms_uint32_t L1GtfeWord::m_totalTriggerNr
private

total number of L1A sent since start of run

Definition at line 315 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::RecordLength1Mask = 0x00F0000000000000ULL
staticprivate

Definition at line 262 of file L1GtfeWord.h.

const int L1GtfeWord::RecordLength1Shift = 52
staticprivate

Definition at line 271 of file L1GtfeWord.h.

const int L1GtfeWord::RecordLength1Word = 0
staticprivate

Definition at line 256 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::RecordLengthMask = 0x000F000000000000ULL
staticprivate

Definition at line 263 of file L1GtfeWord.h.

const int L1GtfeWord::RecordLengthShift = 48
staticprivate

Definition at line 272 of file L1GtfeWord.h.

const int L1GtfeWord::RecordLengthWord = 0
staticprivate

Definition at line 257 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::SetupVersionMask = 0x00000000FFFFFFFFULL
staticprivate

Definition at line 265 of file L1GtfeWord.h.

const int L1GtfeWord::SetupVersionShift = 0
staticprivate

Definition at line 274 of file L1GtfeWord.h.

const int L1GtfeWord::SetupVersionWord = 0
staticprivate

Definition at line 259 of file L1GtfeWord.h.

const cms_uint64_t L1GtfeWord::TotalTriggerNrMask = 0x00000000FFFFFFFFULL
staticprivate

Definition at line 283 of file L1GtfeWord.h.

const int L1GtfeWord::TotalTriggerNrShift = 0
staticprivate

Definition at line 287 of file L1GtfeWord.h.

const int L1GtfeWord::TotalTriggerNrWord = 1
staticprivate

Definition at line 279 of file L1GtfeWord.h.

Generated for CMSSW Reference Manual by doxygen 1.8.5