HcalUMNioDigi Class Reference

#include <HcalUMNioDigi.h>

Public Member Functions
uint16_t	bunchNumber () const
uint32_t	eventNumber () const
uint8_t	eventType () const
uint32_t	getUserWord (int id) const
bool	getUserWord (int id, uint32_t &value) const
bool	hasUserWord (int id) const
	HcalUMNioDigi ()
	HcalUMNioDigi (const std::vector< uint16_t > &words)
	HcalUMNioDigi (const uint16_t *ptr, int words)
uint16_t	idUserWord (int iword) const
bool	invalid () const
bool	isSpill () const
int	numberUserWords () const
uint32_t	orbitNumber () const
uint32_t	runNumber () const
uint16_t	spillCounter () const
uint32_t	valueUserWord (int iword) const

Private Attributes
std::vector< uint16_t >	payload_

Detailed Description

This class contains the readout data from the uMNio uTCA card as when used for orbit gap operations.

Author

J. Mans - Minnesota

Definition at line 15 of file HcalUMNioDigi.h.

Constructor & Destructor Documentation

HcalUMNioDigi() [1/3]

HcalUMNioDigi::HcalUMNioDigi

(

)

Definition at line 4 of file HcalUMNioDigi.cc.

{}

HcalUMNioDigi() [2/3]

HcalUMNioDigi::HcalUMNioDigi	(	const uint16_t *	ptr,
		int	words
	)

Definition at line 5 of file HcalUMNioDigi.cc.

                                                           {
  payload_.reserve(words);
  for (int i = 0; i < words; i++) {
    payload_.push_back(ptr[i]);
  }
}

References mps_fire::i, and payload_.

HcalUMNioDigi() [3/3]

HcalUMNioDigi::HcalUMNioDigi

(

const std::vector< uint16_t > &

words

)

Definition at line 11 of file HcalUMNioDigi.cc.

: payload_(words) {}

Member Function Documentation

bunchNumber()

uint16_t HcalUMNioDigi::bunchNumber

(

)

const

Definition at line 24 of file HcalUMNioDigi.cc.

                                          {
  if (invalid())
    return 0;
  return (payload_[1] >> 4) & 0xFFF;
}

References invalid(), and payload_.

Referenced by operator<<().

eventNumber()

uint32_t HcalUMNioDigi::eventNumber

(

)

const

Definition at line 29 of file HcalUMNioDigi.cc.

                                          {
  if (invalid())
    return 0;
  return payload_[2] + (uint32_t(payload_[3] & 0xFF) << 16);
}

References invalid(), and payload_.

Referenced by operator<<().

eventType()

uint8_t HcalUMNioDigi::eventType

(

)

const

Definition at line 35 of file HcalUMNioDigi.cc.

                                       {
  if (invalid())
    return 0;
  return (payload_[6] >> 8) & 0xF;
}

References invalid(), and payload_.

Referenced by HFRaddamTask::_isApplicable(), QIE11Task::_isApplicable(), PedestalTask::_isApplicable(), LEDTask::_isApplicable(), LaserTask::_isApplicable(), UMNioTask::_process(), and operator<<().

getUserWord() [1/2]

uint32_t HcalUMNioDigi::getUserWord

(

int

id

)

const

Definition at line 71 of file HcalUMNioDigi.cc.

                                                {
  uint32_t dummy(0);
  getUserWord(id, dummy);
  return dummy;
}

Referenced by hasUserWord().

getUserWord() [2/2]

bool HcalUMNioDigi::getUserWord	(	int	id,
		uint32_t &	value
	)		const

Definition at line 76 of file HcalUMNioDigi.cc.

                                                             {
  int nwords = numberUserWords();
  if (size_t(16 + nwords * 3) > payload_.size())
    return false;  // invalid format...
 
  for (int i = 0; i < nwords; i++) {
    if (payload_[14 + 3 * i] == id) {
      value = payload_[15 + 3 * i] + (uint32_t(payload_[16 + 3 * i]) << 16);
      return true;
    }
  }
  return false;
}

References mps_fire::i, numberUserWords(), and payload_.

hasUserWord()

bool HcalUMNioDigi::hasUserWord

(

int

id

)

const

Definition at line 67 of file HcalUMNioDigi.cc.

                                            {
  uint32_t dummy;
  return getUserWord(id, dummy);
}

References getUserWord().

idUserWord()

uint16_t HcalUMNioDigi::idUserWord

(

int

iword

)

const

Definition at line 57 of file HcalUMNioDigi.cc.

                                                  {
  if (iword >= numberUserWords() || payload_.size() < (size_t)(16 + iword * 3))
    return 0;
  return payload_[13 + 3 * iword];
}

References numberUserWords(), and payload_.

Referenced by operator<<().

invalid()

bool HcalUMNioDigi::invalid ( ) const

inline

Definition at line 30 of file HcalUMNioDigi.h.

{ return (payload_.size() < 16) || (payload_[6] & 0xF000) != 0x2000; }

References payload_.

Referenced by bunchNumber(), eventNumber(), eventType(), isSpill(), numberUserWords(), orbitNumber(), runNumber(), and spillCounter().

isSpill()

bool HcalUMNioDigi::isSpill

(

)

const

Definition at line 45 of file HcalUMNioDigi.cc.

                                  {
  if (invalid())
    return false;
  return (payload_[11] & 0x8000);
}

References invalid(), and payload_.

numberUserWords()

int HcalUMNioDigi::numberUserWords

(

)

const

Definition at line 51 of file HcalUMNioDigi.cc.

                                         {
  if (invalid())
    return 0;
  return (payload_[12] & 0xFF);
}

References invalid(), and payload_.

Referenced by getUserWord(), idUserWord(), operator<<(), and valueUserWord().

orbitNumber()

uint32_t HcalUMNioDigi::orbitNumber

(

)

const

Definition at line 19 of file HcalUMNioDigi.cc.

                                          {
  if (invalid())
    return 0;
  return payload_[5] + (uint32_t(payload_[8]) << 16);
}

References invalid(), and payload_.

Referenced by operator<<().

runNumber()

uint32_t HcalUMNioDigi::runNumber

(

)

const

Definition at line 13 of file HcalUMNioDigi.cc.

                                        {
  if (invalid())
    return 0;
  return payload_[9] + (uint32_t(payload_[10]) << 16);
}

References invalid(), and payload_.

Referenced by operator<<().

spillCounter()

uint16_t HcalUMNioDigi::spillCounter

(

)

const

Definition at line 40 of file HcalUMNioDigi.cc.

                                           {
  if (invalid())
    return 0;
  return (payload_[11]) & 0x7FFF;
}

References invalid(), and payload_.

valueUserWord()

uint32_t HcalUMNioDigi::valueUserWord

(

int

iword

)

const

Definition at line 62 of file HcalUMNioDigi.cc.

                                                     {
  if (iword >= numberUserWords() || payload_.size() < (size_t)(16 + iword * 3))
    return 0;
  return payload_[14 + 3 * iword] + (uint32_t(payload_[15 + 3 * iword]) << 16);
}

References numberUserWords(), and payload_.

Referenced by HFRaddamTask::_isApplicable(), QIE11Task::_isApplicable(), LaserTask::_isApplicable(), UMNioTask::_process(), and operator<<().

Member Data Documentation

payload_

std::vector<uint16_t> HcalUMNioDigi::payload_

private

Definition at line 40 of file HcalUMNioDigi.h.

Referenced by bunchNumber(), eventNumber(), eventType(), getUserWord(), HcalUMNioDigi(), idUserWord(), invalid(), isSpill(), numberUserWords(), orbitNumber(), runNumber(), spillCounter(), and valueUserWord().