HcalDCCHeader Class Reference

Interpretive class for an HcalDCCHeader. More...

#include <EventFilter/HcalRawToDigi/interface/HcalDCCHeader.h>

List of all members.

Public Member Functions

unsigned short BOEshouldBe5Always () const

Get the inviolable '5' in the highest 4 bits of the CDF header.

short BOEshouldBeZeroAlways () const

Get the Beginning Of Event bits.

void clear ()

clear the contents of this header

void copySpigotData (unsigned int spigot_id, const HcalHTRData &data, bool valid=true, unsigned char LRB_error_word=0)

Add the given HcalHTRData as the given spigot's data.

int getAcceptTimeTTS () const

int getBunchId () const

get the bunch id from the CDF header

bool getBxMismatchWithDCC (unsigned int nspigot) const

Read the "BxID FAILS TO MATCH WITH DCC" bit for this spigot.

int getByte1Zeroes () const

int getByte3Zeroes () const

int getByte567Zeroes () const

unsigned short getCDFEventType () const

Get the Event Type value (2007.11.03 - Not defined, but should stay consistent among events.

short getCDFversionNumber () const

Get the Format Version of the Common Data Format.

short getDCCDataFormatVersion () const

unsigned long getDCCEventNumber () const

get the Event Number from the CDF header

int getDCCStatus () const

int getHTRStatusBits () const

unsigned char getLRBErrorBits (unsigned int nspigot) const

Access the Link Receiver Board error bits (decoding tbd).

unsigned int getOrbitNumber () const

Get the Orbit Number from the CDF.

unsigned int getSlink64ReservedBits () const

get the (undefined) 'Reserved' part of the second Slink64 CDF word

int getSourceId () const

get the source id from the CDF header

bool getSpigotCRCError (unsigned int nspigot) const

Read the "CRC-Mismatch" bit for this spigot.

void getSpigotData (int nspigot, HcalHTRData &decodeTool) const

Old (unsafe) getSpigotData.

int getSpigotData (int nspigot, HcalHTRData &decodeTool, int validSize) const

Load the given decoder with the pointer and length from this spigot Returns 0 on success Returns -1 if spigot points to data area beyond validSize.

unsigned int getSpigotDataLength (int nspigot) const

Get the size (in 32-bit words) of the data from this spigot.

bool getSpigotDataTruncated (unsigned int nspigot) const

Read the "TRUNCATED" bit for this spigot; LRB truncated data (took too long).

bool getSpigotEnabled (unsigned int nspigot) const

Read the "ENABLED" bit for this spigot.

unsigned char getSpigotErrorBits (unsigned int nspigot) const

Access the HTR error bits (decoding tbd).

bool getSpigotErrorFlag (int nspigot) const

Get the value flagging a spigot's summary of error flags.

bool getSpigotPresent (unsigned int nspigot) const

Read the "PRESENT" bit for this spigot.

int getSpigotSummary (int nspigot) const

Get a given spigot summary from the DCC Header.

bool getSpigotValid (unsigned int nspigot) const

Read the "VALID" bit for this spigot; TTC EvN matched HTR EvN.

unsigned int getTotalLengthBytes () const

Determine the expected total length of this packet in bytes.

HcalDCCHeader ()

bool SawCT_BcN_MxMx () const

bool SawCT_EvN_MxMx () const

bool SawL1A_BcN_MxMx () const

bool SawL1A_EvN_MxMx () const

bool SawOrbitLengthErr () const

bool SawTTC_DoubErr () const

bool SawTTC_SingErr () const

bool SawTTS_BSY () const

bool SawTTS_OFW () const

Get the status of these error counters in the DCC motherboard.

bool SawTTS_SYN () const

void setHeader (int sourceid, int bcn, int l1aN, int orbN)

setup the header

bool thereIsASecondCDFHeaderWord () const

get the bit indicating that another CDF header Slink64 word follows the first one.

bool thereIsAThirdCDFHeaderWord () const

Check the third bit of second Slink64 CDF word.

Static Public Attributes

static const int SPIGOT_COUNT = 15

Private Attributes

unsigned int commondataformat0

unsigned int commondataformat1

unsigned int commondataformat2

unsigned int commondataformat3

unsigned int dcch0

unsigned int dcch1

unsigned int spigotInfo [18]

Detailed Description

Interpretive class for an HcalDCCHeader.

Date: 2008/09/11 13:19:21

Revision: 1.7

Author:: J. Mans - UMD

Definition at line 18 of file HcalDCCHeader.h.

Constructor & Destructor Documentation

HcalDCCHeader::HcalDCCHeader ( )

Definition at line 14 of file HcalDCCHeader.cc.

00014 { }

Member Function Documentation

unsigned short HcalDCCHeader::BOEshouldBe5Always ( ) const [inline]

Get the inviolable '5' in the highest 4 bits of the CDF header.

Definition at line 41 of file HcalDCCHeader.h.

References commondataformat1.

Referenced by HcalDataFormatMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00041 { return ( (commondataformat1>>28) & 0x0F ); }

short HcalDCCHeader::BOEshouldBeZeroAlways ( ) const [inline]

Get the Beginning Of Event bits.

If it's not the first or last CDF Slink64 word, the high 4 bits must be zero.

Definition at line 51 of file HcalDCCHeader.h.

References commondataformat3.

Referenced by HcalDataFormatMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00051 { return ( (commondataformat3>>28) & 0x0F); }

void HcalDCCHeader::clear ( void )

clear the contents of this header

Definition at line 42 of file HcalDCCHeader.cc.

References commondataformat0, commondataformat1, commondataformat2, commondataformat3, dcch0, dcch1, i, and spigotInfo.

Referenced by HcalPacker::pack(), and CastorPacker::pack().

00042                           {
00043   commondataformat0=0;
00044   commondataformat1=0x50000000u;
00045   commondataformat2=0;
00046   commondataformat3=0;
00047   dcch0=0x1; // format version 1
00048   dcch1=0;
00049   for (int i=0; i<18; i++) 
00050     spigotInfo[i]=0;
00051 }

void HcalDCCHeader::copySpigotData	(	unsigned int	spigot_id,
		const HcalHTRData &	data,
		bool	valid = `true`,
		unsigned char	LRB_error_word = `0`
	)

Add the given HcalHTRData as the given spigot's data.

This should be done in increasing spigot order!

Parameters:

	spigot_id
	spigot_data
	valid	flag
	LRB_error_word

Definition at line 58 of file HcalDCCHeader.cc.

References dcch0, HcalHTRData::getErrorsWord(), HcalHTRData::getRawData(), HcalHTRData::getRawLength(), getSpigotDataLength(), i, SPIGOT_COUNT, and spigotInfo.

Referenced by HcalPacker::pack(), and CastorPacker::pack().

00058                                                                                                                             {
00059   if (spigot_id>=(unsigned int)SPIGOT_COUNT) return;
00060   // construct the spigot info
00061   spigotInfo[spigot_id]=(data.getRawLength()/2)|0xc000;
00062   if (valid) spigotInfo[spigot_id]|=0x2000;
00063   spigotInfo[spigot_id]|=(LRB_error_word<<16)|((data.getErrorsWord()&0xFF)<<24);
00064   // status info...
00065   if (valid) dcch0|=(1<<(spigot_id+14));
00066   // copy
00067   unsigned int lenSoFar=0;
00068   for (unsigned int i=0; i<spigot_id; i++) lenSoFar+=getSpigotDataLength(i);
00069   unsigned short* startingPoint=((unsigned short*)this)+sizeof(HcalDCCHeader)/sizeof(unsigned short)+lenSoFar*2;
00070   memcpy(startingPoint,data.getRawData(),sizeof(unsigned short)*data.getRawLength());
00071   // update the trailer...
00072   lenSoFar+=data.getRawLength()/2; // 32-bit words
00073   uint32_t* trailer=((uint32_t*)this)+sizeof(HcalDCCHeader)/sizeof(uint32_t)+lenSoFar;
00074   int len64=sizeof(HcalDCCHeader)/8+lenSoFar/2+1; 
00075   trailer[1]=0;
00076   trailer[0]=0xA0000000u|len64;
00077 }

int HcalDCCHeader::getAcceptTimeTTS ( ) const [inline]

Definition at line 55 of file HcalDCCHeader.h.

References dcch0.

00055 { return ((dcch0>>8)& 0x0000000F); }

int HcalDCCHeader::getBunchId ( ) const [inline]

get the bunch id from the CDF header

Definition at line 35 of file HcalDCCHeader.h.

References commondataformat0.

Referenced by HcalExpertMonitor::unpack(), and HcalDataFormatMonitor::unpack().

00035 { return (commondataformat0>>20)&0xFFF; }

bool HcalDCCHeader::getBxMismatchWithDCC ( unsigned int nspigot ) const [inline]

Read the "BxID FAILS TO MATCH WITH DCC" bit for this spigot.

Definition at line 100 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by HcalDataFormatMonitor::unpack().

00100 { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x2000); }

int HcalDCCHeader::getByte1Zeroes ( ) const [inline]

Definition at line 56 of file HcalDCCHeader.h.

References dcch0.

00056 {  return ((dcch0>>12)& 0x00000003); }

int HcalDCCHeader::getByte3Zeroes ( ) const [inline]

Definition at line 58 of file HcalDCCHeader.h.

References dcch0.

00058 {  return ((dcch0>>29)& 0x00000007); }

int HcalDCCHeader::getByte567Zeroes ( ) const [inline]

Definition at line 60 of file HcalDCCHeader.h.

References dcch1.

00060 {  return (dcch1 & 0xFF00FC00); }

unsigned short HcalDCCHeader::getCDFEventType ( ) const [inline]

Get the Event Type value (2007.11.03 - Not defined, but should stay consistent among events.

)

Definition at line 39 of file HcalDCCHeader.h.

References commondataformat1.

Referenced by HcalDataFormatMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00039 { return ( (commondataformat1>>24) & 0x0F ); }

short HcalDCCHeader::getCDFversionNumber ( ) const [inline]

Get the Format Version of the Common Data Format.

Definition at line 31 of file HcalDCCHeader.h.

References commondataformat0.

Referenced by HcalDataFormatMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00031 {return ((commondataformat0>>4) & 0x0F); }

short HcalDCCHeader::getDCCDataFormatVersion ( ) const [inline]

Definition at line 54 of file HcalDCCHeader.h.

References dcch0.

Referenced by HcalDataFormatMonitor::unpack().

00054 { return (dcch0 & 0xFF); }

unsigned long HcalDCCHeader::getDCCEventNumber ( ) const [inline]

get the Event Number from the CDF header

Definition at line 37 of file HcalDCCHeader.h.

References commondataformat1.

Referenced by HcalExpertMonitor::unpack(), and HcalDataFormatMonitor::unpack().

00037 { return (commondataformat1 & 0x00FFFFFF); }

int HcalDCCHeader::getDCCStatus ( ) const [inline]

Definition at line 59 of file HcalDCCHeader.h.

References dcch1.

Referenced by SawCT_BcN_MxMx(), SawCT_EvN_MxMx(), SawL1A_BcN_MxMx(), SawL1A_EvN_MxMx(), SawOrbitLengthErr(), SawTTC_DoubErr(), SawTTC_SingErr(), SawTTS_BSY(), SawTTS_OFW(), and SawTTS_SYN().

00059 {return (dcch1 & 0x000003FF);}

int HcalDCCHeader::getHTRStatusBits ( ) const [inline]

Definition at line 57 of file HcalDCCHeader.h.

References dcch0.

00057 { return ((dcch0>>14)& 0x00007FFF); }

unsigned char HcalDCCHeader::getLRBErrorBits ( unsigned int nspigot ) const [inline]

Access the Link Receiver Board error bits (decoding tbd).

Definition at line 110 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by operator<<(), HcalDataFormatMonitor::unpack(), and HcalEEUSMonitor::unpack().

00110 { return (nspigot>=15)?(0):((unsigned char)(spigotInfo[nspigot]>>16)); }

unsigned int HcalDCCHeader::getOrbitNumber ( ) const [inline]

Get the Orbit Number from the CDF.

Definition at line 47 of file HcalDCCHeader.h.

References commondataformat2.

Referenced by HcalDataFormatMonitor::unpack(), and HcalEEUSMonitor::unpack().

00047 { return (commondataformat2>>4); }

unsigned int HcalDCCHeader::getSlink64ReservedBits ( ) const [inline]

get the (undefined) 'Reserved' part of the second Slink64 CDF word

Definition at line 49 of file HcalDCCHeader.h.

References commondataformat3.

Referenced by HcalDataFormatMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00049 { return (  (commondataformat3>>4)&0x00FFFFFF ); }

int HcalDCCHeader::getSourceId ( ) const [inline]

get the source id from the CDF header

Definition at line 33 of file HcalDCCHeader.h.

References commondataformat0.

Referenced by HcalMonitorModule::CheckSubdetectorStatus(), HcalDataFormatMonitor::processEvent(), HcalExpertMonitor::unpack(), HcalDataFormatMonitor::unpack(), CastorUnpacker::unpack(), HcalEEUSMonitor::unpack(), HcalDataIntegrityTask::unpack(), and HcalUnpacker::unpack().

00033 { return (commondataformat0>>8)&0xFFF; }

bool HcalDCCHeader::getSpigotCRCError ( unsigned int nspigot ) const [inline]

Read the "CRC-Mismatch" bit for this spigot.

Definition at line 106 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by HcalUnpacker::unpack().

00106 { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x0400); }

void HcalDCCHeader::getSpigotData	(	int	nspigot,
		HcalHTRData &	decodeTool
	)			const

Old (unsafe) getSpigotData.

All calls should be replaced by the new call. This call will generate WARN log messages.

Definition at line 23 of file HcalDCCHeader.cc.

References getSpigotData().

00023                                                                             {
00024   edm::LogWarning("HCAL-Unpacker") << "Using unsafe getSpigotData without length controls.  Not recommended!  Replace with new getSpigotData call";
00025   getSpigotData(nspigot,decodeTool,10000000);
00026 }

int HcalDCCHeader::getSpigotData	(	int	nspigot,
		HcalHTRData &	decodeTool,
		int	validSize
	)			const

Load the given decoder with the pointer and length from this spigot Returns 0 on success Returns -1 if spigot points to data area beyond validSize.

Definition at line 29 of file HcalDCCHeader.cc.

References HcalHTRData::adoptData(), i, len, offset, and spigotInfo.

Referenced by HcalMonitorModule::CheckSubdetectorStatus(), getSpigotData(), HcalDataFormatMonitor::unpack(), CastorUnpacker::unpack(), HcalEEUSMonitor::unpack(), and HcalUnpacker::unpack().

00029                                                                                           {
00030   const unsigned short* base=((unsigned short*)this)+sizeof(HcalDCCHeader)/sizeof(unsigned short);
00031   int offset=0,i,len=0;
00032   for (i=0; i<=nspigot; i++) {
00033     offset+=len;
00034     len=(spigotInfo[i]&0x3FF)*2;
00035   }
00036   if ((offset+len+sizeof(HcalDCCHeader)/sizeof(unsigned short))<(validSize/sizeof(unsigned short))) {
00037     decodeTool.adoptData(base+offset,len);
00038     return 0;
00039   } else { return -1; }
00040 }

unsigned int HcalDCCHeader::getSpigotDataLength ( int nspigot ) const [inline]

Get the size (in 32-bit words) of the data from this spigot.

Definition at line 93 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by copySpigotData(), operator<<(), and HcalDataFormatMonitor::unpack().

00093 { return (nspigot>=15)?(0):(spigotInfo[nspigot]&0x3ff); }

bool HcalDCCHeader::getSpigotDataTruncated ( unsigned int nspigot ) const [inline]

Read the "TRUNCATED" bit for this spigot; LRB truncated data (took too long).

Definition at line 104 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by HcalDataFormatMonitor::unpack().

00104 { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x0800); }

bool HcalDCCHeader::getSpigotEnabled ( unsigned int nspigot ) const [inline]

Read the "ENABLED" bit for this spigot.

Definition at line 96 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by operator<<(), and HcalDataFormatMonitor::unpack().

00096 { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x8000); }

unsigned char HcalDCCHeader::getSpigotErrorBits ( unsigned int nspigot ) const [inline]

Access the HTR error bits (decoding tbd).

Definition at line 108 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by operator<<(), HcalDataFormatMonitor::unpack(), and HcalEEUSMonitor::unpack().

00108 { return (nspigot>=15)?(0):((unsigned char)(spigotInfo[nspigot]>>24)); }

bool HcalDCCHeader::getSpigotErrorFlag ( int nspigot ) const [inline]

Get the value flagging a spigot's summary of error flags.

Definition at line 63 of file HcalDCCHeader.h.

References dcch0.

Referenced by HcalDataFormatMonitor::unpack().

00063                                                     { 
00064     return (( dcch0>>(14+nspigot) )&0x0001);  }

bool HcalDCCHeader::getSpigotPresent ( unsigned int nspigot ) const [inline]

Read the "PRESENT" bit for this spigot.

Definition at line 98 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by HcalMonitorModule::CheckSubdetectorStatus(), operator<<(), HcalDataFormatMonitor::unpack(), CastorUnpacker::unpack(), HcalEEUSMonitor::unpack(), and HcalUnpacker::unpack().

00098 { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x4000); }

int HcalDCCHeader::getSpigotSummary ( int nspigot ) const [inline]

Get a given spigot summary from the DCC Header.

Definition at line 79 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by HcalDataFormatMonitor::unpack().

00079 { return spigotInfo[nspigot]; }

bool HcalDCCHeader::getSpigotValid ( unsigned int nspigot ) const [inline]

Read the "VALID" bit for this spigot; TTC EvN matched HTR EvN.

Definition at line 102 of file HcalDCCHeader.h.

References spigotInfo.

Referenced by operator<<(), and HcalDataFormatMonitor::unpack().

00102 { return (nspigot>=15)?(false):(spigotInfo[nspigot]&0x1000); }

unsigned int HcalDCCHeader::getTotalLengthBytes ( ) const

Determine the expected total length of this packet in bytes.

Definition at line 16 of file HcalDCCHeader.cc.

References i, SPIGOT_COUNT, and spigotInfo.

00016                                                       { 
00017   unsigned int totalSize=sizeof(HcalDCCHeader);
00018   for (int i=0; i<SPIGOT_COUNT; i++) 
00019     totalSize+=(spigotInfo[i]&0x3FF)*4;
00020   return totalSize;
00021 }

bool HcalDCCHeader::SawCT_BcN_MxMx ( ) const [inline]

Definition at line 73 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00073 { return ((getDCCStatus()>>6) & 0x00000001);}

bool HcalDCCHeader::SawCT_EvN_MxMx ( ) const [inline]

Definition at line 72 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00072 { return ((getDCCStatus()>>5) & 0x00000001);}

bool HcalDCCHeader::SawL1A_BcN_MxMx ( ) const [inline]

Definition at line 71 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00071 { return ((getDCCStatus()>>4) & 0x00000001);}

bool HcalDCCHeader::SawL1A_EvN_MxMx ( ) const [inline]

Definition at line 70 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00070 { return ((getDCCStatus()>>3) & 0x00000001);}

bool HcalDCCHeader::SawOrbitLengthErr ( ) const [inline]

Definition at line 74 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00074 { return ((getDCCStatus()>>7) & 0x00000001);}

bool HcalDCCHeader::SawTTC_DoubErr ( ) const [inline]

Definition at line 76 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00076 { return ((getDCCStatus()>>9) & 0x00000001);}

bool HcalDCCHeader::SawTTC_SingErr ( ) const [inline]

Definition at line 75 of file HcalDCCHeader.h.

References getDCCStatus().

Referenced by HcalDataFormatMonitor::unpack().

00075 { return ((getDCCStatus()>>8) & 0x00000001);}

bool HcalDCCHeader::SawTTS_BSY ( ) const [inline]

Definition at line 68 of file HcalDCCHeader.h.

References getDCCStatus().

00068 { return ((getDCCStatus()>>1) & 0x00000001);}

bool HcalDCCHeader::SawTTS_OFW ( ) const [inline]

Get the status of these error counters in the DCC motherboard.

Definition at line 67 of file HcalDCCHeader.h.

References getDCCStatus().

00067 { return ((getDCCStatus()>>0) & 0x00000001);}

bool HcalDCCHeader::SawTTS_SYN ( ) const [inline]

Definition at line 69 of file HcalDCCHeader.h.

References getDCCStatus().

00069 { return ((getDCCStatus()>>2) & 0x00000001);}

void HcalDCCHeader::setHeader	(	int	sourceid,
		int	bcn,
		int	l1aN,
		int	orbN
	)

setup the header

Definition at line 53 of file HcalDCCHeader.cc.

References commondataformat0, and commondataformat1.

Referenced by HcalPacker::pack(), and CastorPacker::pack().

00053                                                                        {
00054   commondataformat0=0x8|((sourceid&0xFFF)<<8)|((bcn&0xFFF)<<20);
00055   commondataformat1=0x50000000u|(l1aN&0xFFFFFF);
00056 }

bool HcalDCCHeader::thereIsASecondCDFHeaderWord ( ) const [inline]

get the bit indicating that another CDF header Slink64 word follows the first one.

Definition at line 29 of file HcalDCCHeader.h.

References commondataformat0.

Referenced by HcalExpertMonitor::unpack(), HcalDataFormatMonitor::unpack(), HcalEEUSMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00029 {return ((commondataformat0>>3) & 0x0001); }

bool HcalDCCHeader::thereIsAThirdCDFHeaderWord ( ) const [inline]

Check the third bit of second Slink64 CDF word.

Definition at line 45 of file HcalDCCHeader.h.

References commondataformat2.

Referenced by HcalDataFormatMonitor::unpack(), and HcalDataIntegrityTask::unpack().

00045 {return ((commondataformat2>>3) & 0x0001); }

Member Data Documentation

unsigned int HcalDCCHeader::commondataformat0 [private]

Definition at line 128 of file HcalDCCHeader.h.

Referenced by clear(), getBunchId(), getCDFversionNumber(), getSourceId(), setHeader(), and thereIsASecondCDFHeaderWord().

unsigned int HcalDCCHeader::commondataformat1 [private]

Definition at line 129 of file HcalDCCHeader.h.

Referenced by BOEshouldBe5Always(), clear(), getCDFEventType(), getDCCEventNumber(), and setHeader().

unsigned int HcalDCCHeader::commondataformat2 [private]

Definition at line 130 of file HcalDCCHeader.h.

Referenced by clear(), getOrbitNumber(), and thereIsAThirdCDFHeaderWord().

unsigned int HcalDCCHeader::commondataformat3 [private]

Definition at line 131 of file HcalDCCHeader.h.

Referenced by BOEshouldBeZeroAlways(), clear(), and getSlink64ReservedBits().

unsigned int HcalDCCHeader::dcch0 [private]

Definition at line 132 of file HcalDCCHeader.h.

Referenced by clear(), copySpigotData(), getAcceptTimeTTS(), getByte1Zeroes(), getByte3Zeroes(), getDCCDataFormatVersion(), getHTRStatusBits(), and getSpigotErrorFlag().

unsigned int HcalDCCHeader::dcch1 [private]

Definition at line 133 of file HcalDCCHeader.h.

Referenced by clear(), getByte567Zeroes(), and getDCCStatus().

const int HcalDCCHeader::SPIGOT_COUNT = 15 [static]

Definition at line 20 of file HcalDCCHeader.h.

Referenced by HcalMonitorModule::CheckSubdetectorStatus(), copySpigotData(), HcalDigiMonitor::fill_Nevents(), HcalTrigPrimMonitor::fill_Nevents(), getTotalLengthBytes(), HcalDataFormatMonitor::label_ySpigots(), operator<<(), HcalEEUSMonitor::setup(), HcalDigiMonitor::setup(), HcalDataFormatMonitor::setup(), HcalTrigPrimMonitor::setup(), HcalDataFormatMonitor::unpack(), CastorUnpacker::unpack(), HcalEEUSMonitor::unpack(), and HcalUnpacker::unpack().

unsigned int HcalDCCHeader::spigotInfo[18] [private]

Definition at line 134 of file HcalDCCHeader.h.

Referenced by clear(), copySpigotData(), getBxMismatchWithDCC(), getLRBErrorBits(), getSpigotCRCError(), getSpigotData(), getSpigotDataLength(), getSpigotDataTruncated(), getSpigotEnabled(), getSpigotErrorBits(), getSpigotPresent(), getSpigotSummary(), getSpigotValid(), and getTotalLengthBytes().

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

EventFilter/HcalRawToDigi/interface/HcalDCCHeader.h
EventFilter/HcalRawToDigi/src/HcalDCCHeader.cc

Generated on Tue Jun 9 18:23:32 2009 for CMSSW by

1.5.4


Public Member Functions
unsigned short	BOEshouldBe5Always () const
	Get the inviolable '5' in the highest 4 bits of the CDF header.
short	BOEshouldBeZeroAlways () const
	Get the Beginning Of Event bits.
void	clear ()
	clear the contents of this header
void	copySpigotData (unsigned int spigot_id, const HcalHTRData &data, bool valid=true, unsigned char LRB_error_word=0)
	Add the given HcalHTRData as the given spigot's data.
int	getAcceptTimeTTS () const
int	getBunchId () const
	get the bunch id from the CDF header
bool	getBxMismatchWithDCC (unsigned int nspigot) const
	Read the "BxID FAILS TO MATCH WITH DCC" bit for this spigot.
int	getByte1Zeroes () const
int	getByte3Zeroes () const
int	getByte567Zeroes () const
unsigned short	getCDFEventType () const
	Get the Event Type value (2007.11.03 - Not defined, but should stay consistent among events.
short	getCDFversionNumber () const
	Get the Format Version of the Common Data Format.
short	getDCCDataFormatVersion () const
unsigned long	getDCCEventNumber () const
	get the Event Number from the CDF header
int	getDCCStatus () const
int	getHTRStatusBits () const
unsigned char	getLRBErrorBits (unsigned int nspigot) const
	Access the Link Receiver Board error bits (decoding tbd).
unsigned int	getOrbitNumber () const
	Get the Orbit Number from the CDF.
unsigned int	getSlink64ReservedBits () const
	get the (undefined) 'Reserved' part of the second Slink64 CDF word
int	getSourceId () const
	get the source id from the CDF header
bool	getSpigotCRCError (unsigned int nspigot) const
	Read the "CRC-Mismatch" bit for this spigot.
void	getSpigotData (int nspigot, HcalHTRData &decodeTool) const
	Old (unsafe) getSpigotData.
int	getSpigotData (int nspigot, HcalHTRData &decodeTool, int validSize) const
	Load the given decoder with the pointer and length from this spigot Returns 0 on success Returns -1 if spigot points to data area beyond validSize.
unsigned int	getSpigotDataLength (int nspigot) const
	Get the size (in 32-bit words) of the data from this spigot.
bool	getSpigotDataTruncated (unsigned int nspigot) const
	Read the "TRUNCATED" bit for this spigot; LRB truncated data (took too long).
bool	getSpigotEnabled (unsigned int nspigot) const
	Read the "ENABLED" bit for this spigot.
unsigned char	getSpigotErrorBits (unsigned int nspigot) const
	Access the HTR error bits (decoding tbd).
bool	getSpigotErrorFlag (int nspigot) const
	Get the value flagging a spigot's summary of error flags.
bool	getSpigotPresent (unsigned int nspigot) const
	Read the "PRESENT" bit for this spigot.
int	getSpigotSummary (int nspigot) const
	Get a given spigot summary from the DCC Header.
bool	getSpigotValid (unsigned int nspigot) const
	Read the "VALID" bit for this spigot; TTC EvN matched HTR EvN.
unsigned int	getTotalLengthBytes () const
	Determine the expected total length of this packet in bytes.
	HcalDCCHeader ()
bool	SawCT_BcN_MxMx () const
bool	SawCT_EvN_MxMx () const
bool	SawL1A_BcN_MxMx () const
bool	SawL1A_EvN_MxMx () const
bool	SawOrbitLengthErr () const
bool	SawTTC_DoubErr () const
bool	SawTTC_SingErr () const
bool	SawTTS_BSY () const
bool	SawTTS_OFW () const
	Get the status of these error counters in the DCC motherboard.
bool	SawTTS_SYN () const
void	setHeader (int sourceid, int bcn, int l1aN, int orbN)
	setup the header
bool	thereIsASecondCDFHeaderWord () const
	get the bit indicating that another CDF header Slink64 word follows the first one.
bool	thereIsAThirdCDFHeaderWord () const
	Check the third bit of second Slink64 CDF word.
Static Public Attributes
static const int	SPIGOT_COUNT = 15
Private Attributes
unsigned int	commondataformat0
unsigned int	commondataformat1
unsigned int	commondataformat2
unsigned int	commondataformat3
unsigned int	dcch0
unsigned int	dcch1
unsigned int	spigotInfo [18]