FEDHeader Class Reference

#include <FEDHeader.h>

Public Member Functions
uint16_t	bxID () const
	The bunch crossing number. More...
bool	check () const
	Check that the header is OK. More...
	FEDHeader (const unsigned char *header)
	Constructor. More...
uint32_t	lvl1ID () const
	Level-1 event number generated by the TTC system. More...
bool	moreHeaders () const
uint16_t	sourceID () const
	Identifier of the FED. More...
uint8_t	triggerType () const
	Event Trigger type identifier. More...
uint8_t	version () const
	Version identifier of the FED data format. More...
	~FEDHeader ()
	Destructor. More...

Static Public Member Functions
static void	set (unsigned char *header, uint8_t triggerType, uint32_t lvl1ID, uint16_t bxID, uint16_t sourceID, uint8_t version=0, bool moreHeaders=false)
	Set all fields in the header. More...

Static Public Attributes
static const uint32_t	length = sizeof(fedh_t)

Private Attributes
const fedh_struct *	theHeader

Detailed Description

Helper class to interpret/create FED header words.

Author

N. Amapane - CERN, R. Mommsen - FNAL

Definition at line 14 of file FEDHeader.h.

Constructor & Destructor Documentation

FEDHeader()

FEDHeader::FEDHeader

(

const unsigned char *

header

)

Constructor.

Definition at line 9 of file FEDHeader.cc.

: theHeader(reinterpret_cast<const fedh_t*>(header)) {}

~FEDHeader()

FEDHeader::~FEDHeader

(

)

Destructor.

Definition at line 11 of file FEDHeader.cc.

{}

Member Function Documentation

bxID()

uint16_t FEDHeader::bxID

(

)

const

The bunch crossing number.

Definition at line 17 of file FEDHeader.cc.

References FED_BXID_EXTRACT, fedh_struct::sourceid, and theHeader.

Referenced by HcalTBWriter::extractEventInfo(), DTDDUUnpacker::interpretRawData(), ESUnpacker::interpretRawData(), RPCUnpackingModule::produce(), omtf::OmtfUnpacker::produce(), set(), L1GlobalTriggerEvmRawToDigi::unpackHeader(), and L1GlobalTriggerRawToDigi::unpackHeader().

{ return FED_BXID_EXTRACT(theHeader->sourceid); }

check()

bool FEDHeader::check

(

)

const

Check that the header is OK.

Definition at line 44 of file FEDHeader.cc.

References fedh_struct::eventid, FED_HCTRLID_EXTRACT, FED_SLINK_START_MARKER, and theHeader.

Referenced by ErrorCheckerBase::checkHeader(), RPixErrorChecker::checkHeader(), DTDDUUnpacker::interpretRawData(), ESUnpacker::interpretRawData(), DTDDUFileReader::isHeader(), DTSpyReader::isHeader(), RPCUnpackingModule::produce(), and omtf::OmtfUnpacker::produce().

{ return (FED_HCTRLID_EXTRACT(theHeader->eventid) == FED_SLINK_START_MARKER); }

lvl1ID()

uint32_t FEDHeader::lvl1ID

(

)

const

Level-1 event number generated by the TTC system.

Definition at line 15 of file FEDHeader.cc.

References fedh_struct::eventid, FED_LVL1_EXTRACT, and theHeader.

Referenced by DQMHcalPhiSymAlCaReco::analyze(), HcalTBWriter::extractEventInfo(), DTDDUUnpacker::interpretRawData(), ESUnpacker::interpretRawData(), RPCUnpackingModule::produce(), omtf::OmtfUnpacker::produce(), set(), L1GlobalTriggerEvmRawToDigi::unpackHeader(), and L1GlobalTriggerRawToDigi::unpackHeader().

{ return FED_LVL1_EXTRACT(theHeader->eventid); }

moreHeaders()

bool FEDHeader::moreHeaders

(

)

const

0 -> the current header word is the last one. 1-> other header words can follow (always 1 for ECAL)

Definition at line 23 of file FEDHeader.cc.

References FED_MORE_HEADERS_EXTRACT, fedh_struct::sourceid, and theHeader.

Referenced by ErrorCheckerBase::checkHeader(), RPixErrorChecker::checkHeader(), ESUnpacker::interpretRawData(), RPCUnpackingModule::produce(), omtf::OmtfUnpacker::produce(), set(), L1GlobalTriggerEvmRawToDigi::unpackHeader(), and L1GlobalTriggerRawToDigi::unpackHeader().

{ return (FED_MORE_HEADERS_EXTRACT(theHeader->sourceid) != 0); }

set()

void FEDHeader::set ( unsigned char *  header, uint8_t  triggerType, uint32_t  lvl1ID, uint16_t  bxID, uint16_t  sourceID, uint8_t  version = 0, bool  moreHeaders = false  )

static

Set all fields in the header.

Definition at line 25 of file FEDHeader.cc.

References bxID(), FED_BXID_MASK, FED_BXID_SHIFT, FED_BXID_WIDTH, FED_EVTY_MASK, FED_EVTY_SHIFT, FED_HCTRLID_SHIFT, FED_LVL1_MASK, FED_LVL1_SHIFT, FED_MORE_HEADERS_SHIFT, FED_MORE_HEADERS_WIDTH, FED_SLINK_START_MARKER, FED_SOID_MASK, FED_SOID_SHIFT, FED_VERSION_MASK, FED_VERSION_SHIFT, h, RecoTauValidation_cfi::header, lvl1ID(), moreHeaders(), sourceID(), triggerType(), and version().

Referenced by CSCDCCHeader::CSCDCCHeader(), ESDataFormatterV1_1::DigiToRaw(), ESDataFormatterV4::DigiToRaw(), DaqFakeReader::fillFEDs(), DaqFakeReader::fillTCDSFED(), CTPPSTotemDataFormatter::formatRawData(), PixelDataFormatter::formatRawData(), CTPPSPixelDataFormatter::formatRawData(), L1GTEvmDigiToRaw::packHeader(), L1GTDigiToRaw::packHeader(), DTDigiToRawModule::produce(), CSCTFPacker::produce(), RPCTwinMuxDigiToRaw::produce(), GctDigiToRaw::produce(), HcalDigiToRawuHTR::produce(), and RPCPackingModule::rawData().

                                      {
  // FIXME: should check that input ranges are OK!!!
  fedh_t* h = reinterpret_cast<fedh_t*>(header);
  h->eventid = (FED_SLINK_START_MARKER << FED_HCTRLID_SHIFT) | ((triggerType << FED_EVTY_SHIFT) & FED_EVTY_MASK) |
               ((lvl1ID << FED_LVL1_SHIFT) & FED_LVL1_MASK);

  h->sourceid = (((bxID & FED_BXID_WIDTH) << FED_BXID_SHIFT) & FED_BXID_MASK) |
                ((sourceID << FED_SOID_SHIFT) & FED_SOID_MASK) | ((version << FED_VERSION_SHIFT) & FED_VERSION_MASK);

  if (moreHeaders)
    h->sourceid |= (FED_MORE_HEADERS_WIDTH << FED_MORE_HEADERS_SHIFT);
}

sourceID()

uint16_t FEDHeader::sourceID

(

)

const

Identifier of the FED.

Definition at line 19 of file FEDHeader.cc.

References FED_SOID_EXTRACT, fedh_struct::sourceid, and theHeader.

Referenced by ErrorCheckerBase::checkHeader(), RPixErrorChecker::checkHeader(), FedRawDataInputSource::fillFEDRawDataCollection(), ESUnpacker::interpretRawData(), DTDDUFileReader::isHeader(), DTSpyReader::isHeader(), RPCUnpackingModule::produce(), omtf::OmtfUnpacker::produce(), set(), FRDStreamSource::setRunAndEventInfo(), TCDSRecord::TCDSRecord(), L1GlobalTriggerEvmRawToDigi::unpackHeader(), and L1GlobalTriggerRawToDigi::unpackHeader().

{ return FED_SOID_EXTRACT(theHeader->sourceid); }

triggerType()

uint8_t FEDHeader::triggerType

(

)

const

Event Trigger type identifier.

Definition at line 13 of file FEDHeader.cc.

References fedh_struct::eventid, FED_EVTY_EXTRACT, and theHeader.

Referenced by RPCUnpackingModule::produce(), omtf::OmtfUnpacker::produce(), FedRawDataInputSource::read(), set(), FRDStreamSource::setRunAndEventInfo(), TCDSRecord::TCDSRecord(), L1GlobalTriggerEvmRawToDigi::unpackHeader(), and L1GlobalTriggerRawToDigi::unpackHeader().

{ return FED_EVTY_EXTRACT(theHeader->eventid); }

version()

uint8_t FEDHeader::version

(

)

const

Version identifier of the FED data format.

Definition at line 21 of file FEDHeader.cc.

References FED_VERSION_EXTRACT, fedh_struct::sourceid, and theHeader.

Referenced by validation.Sample::datasetpattern(), validation.Sample::filename(), RPCUnpackingModule::produce(), omtf::OmtfUnpacker::produce(), set(), L1GlobalTriggerEvmRawToDigi::unpackHeader(), and L1GlobalTriggerRawToDigi::unpackHeader().

{ return FED_VERSION_EXTRACT(theHeader->sourceid); }

Member Data Documentation

length

const uint32_t FEDHeader::length = sizeof(fedh_t)

static

Definition at line 54 of file FEDHeader.h.

Referenced by evf::evtn::daq_board_sense(), evf::evtn::evm_board_sense(), evf::evtn::evm_tcs_board_sense(), FedRawDataInputSource::fillFEDRawDataCollection(), DaqFakeReader::fillTCDSFED(), evf::evtn::getevtyp(), evf::evtn::getfdlbx(), evf::evtn::getfdlpsc(), evf::evtn::getfdlta1(), evf::evtn::getfdlta2(), evf::evtn::getfdlttr(), evf::evtn::getgpshigh(), evf::evtn::getgpslow(), evf::evtn::getlbn(), evf::evtn::getorbit(), evf::evtn::offset(), OnlineMetaDataRawToDigi::produce(), FedRawDataInputSource::read(), FRDStreamSource::setRunAndEventInfo(), TCDSRecord::TCDSRecord(), and sistrip::RawToDigiUnpacker::triggerFed().

theHeader

const fedh_struct* FEDHeader::theHeader

private

Definition at line 57 of file FEDHeader.h.

Referenced by bxID(), check(), lvl1ID(), moreHeaders(), sourceID(), triggerType(), and version().