CSCTMBHeader Class Reference

#include <CSCTMBHeader.h>

Public Member Functions
void	add (const std::vector< CSCCLCTDigi > &digis)
	these methods need more brains to figure which one goes first More...
void	add (const std::vector< CSCCorrelatedLCTDigi > &digis)
void	addALCT0 (const CSCALCTDigi &digi)
void	addALCT1 (const CSCALCTDigi &digi)
void	addCLCT0 (const CSCCLCTDigi &digi)
	Needed before data packing. More...
void	addCLCT1 (const CSCCLCTDigi &digi)
void	addCorrelatedLCT0 (const CSCCorrelatedLCTDigi &digi)
void	addCorrelatedLCT1 (const CSCCorrelatedLCTDigi &digi)
uint16_t	ALCTMatchTime () const
uint16_t	ALCTOnly () const
uint16_t	Bxn0Diff () const
uint16_t	Bxn1Diff () const
uint16_t	BXNCount () const
bool	check () const
std::vector< CSCCLCTDigi >	CLCTDigis (uint32_t idlayer)
	returns CLCT digis More...
uint16_t	CLCTOnly () const
std::vector< CSCCorrelatedLCTDigi >	CorrelatedLCTDigis (uint32_t idlayer) const
	returns CorrelatedLCT digis More...
	CSCTMBHeader (int firmwareVersion, int firmwareRevision)
	CSCTMBHeader (const CSCTMBStatusDigi &digi)
	CSCTMBHeader (const unsigned short *buf)
unsigned short *	data ()
int	FirmwareRevision () const
int	FirmwareVersion () const
uint16_t	L1ANumber () const
uint16_t	NCFEBs () const
unsigned short int	NHeaderFrames () const
uint16_t	NTBins () const
void	setEventInformation (const CSCDMBHeader &dmbHeader)
	fills fields like bxn and l1a More...
void	setNCFEBs (uint16_t ncfebs)
uint16_t	sizeInBytes () const
unsigned short int	sizeInWords () const
uint16_t	syncError () const
uint16_t	syncErrorCLCT () const
uint16_t	syncErrorMPC0 () const
uint16_t	syncErrorMPC1 () const
CSCTMBHeader2006	tmbHeader2006 () const
CSCTMBHeader2007	tmbHeader2007 () const
	will throw if the cast fails More...
CSCTMBHeader2007_rev0x50c3	tmbHeader2007_rev0x50c3 () const
CSCTMBHeader2013	tmbHeader2013 () const
uint16_t	TMBMatch () const

Static Public Member Functions
static void	selfTest ()
	tests that packing and unpacking give same results More...
static void	setDebug (const bool value)

Private Attributes
int	theFirmwareVersion
boost::shared_ptr < CSCVTMBHeaderFormat >	theHeaderFormat

Static Private Attributes
static std::atomic< bool >	debug {false}

Friends
std::ostream &	operator<< (std::ostream &os, const CSCTMBHeader &hdr)

Detailed Description

Definition at line 25 of file CSCTMBHeader.h.

Constructor & Destructor Documentation

CSCTMBHeader::CSCTMBHeader	(	int	firmwareVersion,
		int	firmwareRevision
	)

Definition at line 20 of file CSCTMBHeader.cc.

References theHeaderFormat.

                                                                   :
  theHeaderFormat(),
  theFirmwareVersion(firmwareVersion)
{
  if(firmwareVersion == 2013)
    {
      theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2013());
    }
  else if(firmwareVersion == 2006)
    {
      theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2006());
    }
  else if(firmwareVersion == 2007)
    {

      /* Checks for TMB2007 firmware revisions ranges to detect data format
       * rev.0x50c3 - first revision with changed format 
       * rev.0x42D5 - oldest known from 06/21/2007
       * There is 4-bits year value rollover in revision number (0 in 2016)
       */
      if((firmwareRevision >= 0x50c3) || (firmwareRevision < 0x42D5))
        { 
          // if (firmwareRevision >= 0x7a76) // First OTMB firmware revision with 2013 format
          /* Revisions > 0x6000 - OTMB firmwares, < 0x42D5 - new TMB revisions in 2016 */
          if ((firmwareRevision >= 0x6000) || (firmwareRevision < 0x42D5))
            {
              theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2013());
            }
          else
            {
              theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007_rev0x50c3());
            }
        }
      else
        {
          theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007());
        }
    }
  else
    {
      edm::LogError("CSCTMBHeader|CSCRawToDigi") <<"failed to determine TMB firmware version!!";
    }
}

CSCTMBHeader::CSCTMBHeader

(

const CSCTMBStatusDigi &

digi

)

CSCTMBHeader::CSCTMBHeader

(

const unsigned short *

buf

)

first determine the format

Definition at line 68 of file CSCTMBHeader.cc.

References theFirmwareVersion, and theHeaderFormat.

  : theHeaderFormat()
{
  if (buf[0]==0xDB0C)
    {
      theFirmwareVersion=2007;
      theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007(buf));
      /* Checks for TMB2007 firmware revisions ranges to detect data format
       * rev.0x50c3 - first revision with changed format 
       * rev.0x42D5 - oldest known from 06/21/2007
       * There is 4-bits year value rollover in revision number (0 in 2016)
       */
      if ((theHeaderFormat->firmwareRevision() >= 0x50c3) || (theHeaderFormat->firmwareRevision() < 0x42D5))
        {
          // if (theHeaderFormat->firmwareRevision() >= 0x7a76) // First OTMB firmware revision with 2013 format
          /* Revisions > 0x6000 - OTMB firmwares, < 0x42D5 - new TMB revisions in 2016 */
          if ((theHeaderFormat->firmwareRevision() >= 0x6000) || (theHeaderFormat->firmwareRevision() < 0x42D5))
            {
              theFirmwareVersion=2013;
              theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2013(buf));
            }
          else
            {
              theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007_rev0x50c3(buf));
            }
        }

    }
  else if (buf[0]==0x6B0C)
    {
      theFirmwareVersion=2006;
      theHeaderFormat = boost::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2006(buf));
    }
  else
    {
      edm::LogError("CSCTMBHeader|CSCRawToDigi") <<"failed to determine TMB firmware version!!";
    }
}

Member Function Documentation

void CSCTMBHeader::add

(

const std::vector< CSCCLCTDigi > &

digis

)

these methods need more brains to figure which one goes first

Definition at line 142 of file CSCTMBHeader.cc.

References addCLCT0(), and addCLCT1().

Referenced by CSCEventData::add(), and counter.Counter::register().

{
  // sort???
  if(digis.size() > 0) { 
    addCLCT0(digis[0]); 
        
  }
  if(digis.size() > 1) addCLCT1(digis[1]);
}

void CSCTMBHeader::add

(

const std::vector< CSCCorrelatedLCTDigi > &

digis

)

Definition at line 152 of file CSCTMBHeader.cc.

References addCorrelatedLCT0(), and addCorrelatedLCT1().

Referenced by counter.Counter::register().

{
  // sort???
  if(digis.size() > 0) addCorrelatedLCT0(digis[0]);
  if(digis.size() > 1) addCorrelatedLCT1(digis[1]);
}

void CSCTMBHeader::addALCT0 ( const CSCALCTDigi &  digi )

inline

Definition at line 134 of file CSCTMBHeader.h.

References theHeaderFormat.

{theHeaderFormat->addALCT0(digi);}

void CSCTMBHeader::addALCT1 ( const CSCALCTDigi &  digi )

inline

Definition at line 135 of file CSCTMBHeader.h.

References theHeaderFormat.

{theHeaderFormat->addALCT1(digi);}

void CSCTMBHeader::addCLCT0 ( const CSCCLCTDigi &  digi )

inline

Needed before data packing.

for data packing

Definition at line 132 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

{theHeaderFormat->addCLCT0(digi);}

void CSCTMBHeader::addCLCT1 ( const CSCCLCTDigi &  digi )

inline

Definition at line 133 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

{theHeaderFormat->addCLCT1(digi);}

void CSCTMBHeader::addCorrelatedLCT0 ( const CSCCorrelatedLCTDigi &  digi )

inline

Definition at line 136 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

                                                            {
    theHeaderFormat->addCorrelatedLCT0(digi);
  }

void CSCTMBHeader::addCorrelatedLCT1 ( const CSCCorrelatedLCTDigi &  digi )

inline

Definition at line 139 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

                                                            {
    theHeaderFormat->addCorrelatedLCT1(digi);
  }

uint16_t CSCTMBHeader::ALCTMatchTime ( ) const

inline

Definition at line 45 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCOfflineMonitor::doBXMonitor(), CSCValidation::doTimeMonitoring(), and cscdqm::EventProcessor::processCSC().

                                 {
    return theHeaderFormat->ALCTMatchTime();
  }

uint16_t CSCTMBHeader::ALCTOnly ( ) const

inline

Definition at line 51 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

                            {
    return theHeaderFormat->ALCTOnly();
  }

uint16_t CSCTMBHeader::Bxn0Diff ( ) const

inline

Definition at line 58 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

                            {
    return theHeaderFormat->Bxn0Diff();
  }

uint16_t CSCTMBHeader::Bxn1Diff ( ) const

inline

Definition at line 61 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

                            {
    return theHeaderFormat->Bxn1Diff();
  }

uint16_t CSCTMBHeader::BXNCount ( ) const

inline

Definition at line 42 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCOfflineMonitor::doBXMonitor(), CSCValidation::doTimeMonitoring(), and cscdqm::EventProcessor::processCSC().

                            {
    return theHeaderFormat->BXNCount();
  }

bool CSCTMBHeader::check ( ) const

inline

Definition at line 124 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::UnpackTMB().

                     {
     return theHeaderFormat->check();
  }

std::vector<CSCCLCTDigi> CSCTMBHeader::CLCTDigis ( uint32_t  idlayer )

inline

returns CLCT digis

Definition at line 98 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC(), selfTest(), and CSCEventData::selfTest().

  {
    return theHeaderFormat->CLCTDigis(idlayer);
  }

uint16_t CSCTMBHeader::CLCTOnly ( ) const

inline

Definition at line 48 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

                            {
    return theHeaderFormat->CLCTOnly();
  }

std::vector<CSCCorrelatedLCTDigi> CSCTMBHeader::CorrelatedLCTDigis ( uint32_t  idlayer ) const

inline

returns CorrelatedLCT digis

Definition at line 104 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by selfTest(), and CSCEventData::selfTest().

  {
    return theHeaderFormat->CorrelatedLCTDigis(idlayer);
  }

unsigned short* CSCTMBHeader::data ( )

inline

Definition at line 117 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cuy.FindIssue::__init__(), CSCTMBData::pack(), and selfTest().

                          {
    return theHeaderFormat->data();
  }

int CSCTMBHeader::FirmwareRevision ( ) const

inline

Definition at line 39 of file CSCTMBHeader.h.

References theHeaderFormat.

{return theHeaderFormat->firmwareRevision();}

int CSCTMBHeader::FirmwareVersion ( ) const

inline

Definition at line 38 of file CSCTMBHeader.h.

References theFirmwareVersion.

Referenced by CSCCLCTData::CSCCLCTData(), and CSCTMBData::UnpackTMB().

{return theFirmwareVersion;}

uint16_t CSCTMBHeader::L1ANumber ( ) const

inline

Definition at line 65 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

                             {
    return theHeaderFormat->L1ANumber();
  }

uint16_t CSCTMBHeader::NCFEBs ( ) const

inline

Definition at line 82 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC(), and CSCTMBData::UnpackTMB().

                          {
    return theHeaderFormat->NCFEBs();
  }

unsigned short int CSCTMBHeader::NHeaderFrames ( ) const

inline

Definition at line 113 of file CSCTMBHeader.h.

References theHeaderFormat.

                                           {
    return theHeaderFormat->NHeaderFrames();
  }

uint16_t CSCTMBHeader::NTBins ( ) const

inline

Definition at line 79 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::UnpackTMB().

                          {
    return theHeaderFormat->NTBins();
  }

void CSCTMBHeader::selfTest ( )

static

tests that packing and unpacking give same results

Definition at line 202 of file CSCTMBHeader.cc.

References addCLCT0(), addCLCT1(), addCorrelatedLCT0(), addCorrelatedLCT1(), assert(), CLCTDigis(), CorrelatedLCTDigis(), gather_cfg::cout, cscPackerCompare(), data(), debug, DetId::rawId(), and relativeConstraints::station.

{
  static bool debug = false;

  // tests packing and unpacking
  for(int station = 1; station <= 4; ++station)
    {
      for(int iendcap = 1; iendcap <= 2; ++iendcap)
        {
          CSCDetId detId(iendcap, station, 1, 1, 0);

          // the next-to-last is the BX, which only gets
          // saved in two bits and must be the same for clct0 and clct1.
          //CSCCLCTDigi clct0(1, 1, 4, 0, 0, 30, 3, 0, 1); // valid for 2006
          // In 2007 firmware, there are no distrips, so the 4th argument (strip
          // type) should always be set to 1 (halfstrips).
          CSCCLCTDigi clct0(1, 1, 4, 1, 0, 30, 4, 2, 1); // valid for 2007
          CSCCLCTDigi clct1(1, 1, 2, 1, 1, 31, 1, 2, 2);

          // BX of LCT (8th argument) is 1-bit word (the least-significant bit
          // of ALCT's bx).
          CSCCorrelatedLCTDigi lct0(1, 1, 2, 10, 98, 5, 0, 1, 0, 0, 0, 0);
          CSCCorrelatedLCTDigi lct1(2, 1, 2, 20, 15, 9, 1, 0, 0, 0, 0, 0);

          CSCTMBHeader tmbHeader(2007, 0x50c3);
          tmbHeader.addCLCT0(clct0);
          tmbHeader.addCLCT1(clct1);
          tmbHeader.addCorrelatedLCT0(lct0);
          tmbHeader.addCorrelatedLCT1(lct1);
          std::vector<CSCCLCTDigi> clcts = tmbHeader.CLCTDigis(detId.rawId());
          // guess they got reordered
          assert(cscPackerCompare(clcts[0],clct0));
          assert(cscPackerCompare(clcts[1],clct1));
          if (debug)
            {
              std::cout << "Match for: " << clct0 << "\n";
              std::cout << "           " << clct1 << "\n \n";
            }

          std::vector<CSCCorrelatedLCTDigi> lcts = tmbHeader.CorrelatedLCTDigis(detId.rawId());
          assert(cscPackerCompare(lcts[0], lct0));
          assert(cscPackerCompare(lcts[1], lct1));
          if (debug)
            {
              std::cout << "Match for: " << lct0 << "\n";
              std::cout << "           " << lct1 << "\n";
            }

          // try packing and re-packing, to make sure they're the same
          unsigned short int * data = tmbHeader.data();
          CSCTMBHeader newHeader(data);
          clcts = newHeader.CLCTDigis(detId.rawId());
          assert(cscPackerCompare(clcts[0],clct0));
          assert(cscPackerCompare(clcts[1],clct1));
          lcts = newHeader.CorrelatedLCTDigis(detId.rawId());
          assert(cscPackerCompare(lcts[0], lct0));
          assert(cscPackerCompare(lcts[1], lct1));


        }
    }
}

static void CSCTMBHeader::setDebug ( const bool  value )

inlinestatic

turns on/off debug flag for this class

Definition at line 122 of file CSCTMBHeader.h.

References debug, and relativeConstraints::value.

Referenced by CSCDCCUnpacker::CSCDCCUnpacker().

{debug = value;}

void CSCTMBHeader::setEventInformation ( const CSCDMBHeader &  dmbHeader )

inline

fills fields like bxn and l1a

Definition at line 33 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::checkTMBClasses(), and CSCEventData::setEventInformation().

  {
    theHeaderFormat->setEventInformation(dmbHeader);
  }

void CSCTMBHeader::setNCFEBs ( uint16_t  ncfebs )

inline

Definition at line 92 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::checkTMBClasses(), CSCTMBData::CSCTMBData(), and CSCEventData::setEventInformation().

                                  {
    theHeaderFormat->setNCFEBs(ncfebs);
  }

uint16_t CSCTMBHeader::sizeInBytes ( ) const

inline

Definition at line 69 of file CSCTMBHeader.h.

References theHeaderFormat.

                               {
    return theHeaderFormat->sizeInWords()*2;
  }

unsigned short int CSCTMBHeader::sizeInWords ( ) const

inline

in 16-bit words. Add olne because we include beginning(b0c) and end (e0c) flags

Definition at line 111 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::CSCTMBData(), CSCTMBData::pack(), and CSCTMBData::UnpackTMB().

{return theHeaderFormat->sizeInWords();}

uint16_t CSCTMBHeader::syncError ( ) const

inline

Definition at line 86 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncError();}

uint16_t CSCTMBHeader::syncErrorCLCT ( ) const

inline

Definition at line 87 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncErrorCLCT();}

uint16_t CSCTMBHeader::syncErrorMPC0 ( ) const

inline

Definition at line 88 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncErrorMPC0();}

uint16_t CSCTMBHeader::syncErrorMPC1 ( ) const

inline

Definition at line 89 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncErrorMPC1();}

CSCTMBHeader2006 CSCTMBHeader::tmbHeader2006

(

)

const

Definition at line 191 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

{
  CSCTMBHeader2006 * result = dynamic_cast<CSCTMBHeader2006 *>(theHeaderFormat.get());
  if(result == 0)
    {
      throw cms::Exception("Could not get 2006 TMB header format");
    }
  return *result;
}

CSCTMBHeader2007 CSCTMBHeader::tmbHeader2007

(

)

const

will throw if the cast fails

Definition at line 160 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

{
  CSCTMBHeader2007 * result = dynamic_cast<CSCTMBHeader2007 *>(theHeaderFormat.get());
  if(result == 0)
    {
      throw cms::Exception("Could not get 2007 TMB header format");
    }
  return *result;
}

CSCTMBHeader2007_rev0x50c3 CSCTMBHeader::tmbHeader2007_rev0x50c3

(

)

const

Definition at line 170 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

{
  CSCTMBHeader2007_rev0x50c3 * result = dynamic_cast<CSCTMBHeader2007_rev0x50c3 *>(theHeaderFormat.get());
  if(result == 0)
    {
      throw cms::Exception("Could not get 2007 rev0x50c3 TMB header format");
    }
  return *result;
}

CSCTMBHeader2013 CSCTMBHeader::tmbHeader2013

(

)

const

Definition at line 180 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

{
  CSCTMBHeader2013 * result = dynamic_cast<CSCTMBHeader2013 *>(theHeaderFormat.get());
  if(result == 0)
    {
      throw cms::Exception("Could not get 2013 TMB header format");
    }
  return *result;
}

uint16_t CSCTMBHeader::TMBMatch ( ) const

inline

Definition at line 54 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

                            {
    return theHeaderFormat->TMBMatch();
  }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CSCTMBHeader &  hdr  )

friend

Definition at line 266 of file CSCTMBHeader.cc.

{
  hdr.theHeaderFormat->print(os);
  return os;
}

Member Data Documentation

std::atomic< bool > CSCTMBHeader::debug {false}

staticprivate

Definition at line 160 of file CSCTMBHeader.h.

Referenced by util.rrapi.RRApi::dprint(), rrapi.RRApi::dprint(), pkg.AbstractPkg::generate(), util.rrapi.RRApi::get(), rrapi.RRApi::get(), pkg.AbstractPkg::get_kwds(), selfTest(), setDebug(), and pkg.AbstractPkg::write().

int CSCTMBHeader::theFirmwareVersion

private

Definition at line 164 of file CSCTMBHeader.h.

Referenced by CSCTMBHeader(), and FirmwareVersion().

boost::shared_ptr<CSCVTMBHeaderFormat> CSCTMBHeader::theHeaderFormat

private

Definition at line 163 of file CSCTMBHeader.h.

Referenced by addALCT0(), addALCT1(), addCLCT0(), addCLCT1(), addCorrelatedLCT0(), addCorrelatedLCT1(), ALCTMatchTime(), ALCTOnly(), Bxn0Diff(), Bxn1Diff(), BXNCount(), check(), CLCTDigis(), CLCTOnly(), CorrelatedLCTDigis(), CSCTMBHeader(), data(), FirmwareRevision(), L1ANumber(), NCFEBs(), NHeaderFrames(), NTBins(), operator<<(), setEventInformation(), setNCFEBs(), sizeInBytes(), sizeInWords(), syncError(), syncErrorCLCT(), syncErrorMPC0(), syncErrorMPC1(), tmbHeader2006(), tmbHeader2007(), tmbHeader2007_rev0x50c3(), tmbHeader2013(), and TMBMatch().