TotemTimingDigi Class Reference

#include <TotemTimingDigi.h>

Public Member Functions
void	addSample (const uint8_t sampleValue)
unsigned int	cellInfo () const
TotemTimingEventInfo	eventInfo () const
unsigned int	fpgaTimestamp () const
unsigned int	hardwareBoardId () const
unsigned int	hardwareChannelId () const
unsigned int	hardwareId () const
	Return digi values number. More...
unsigned int	hardwareSampicId () const
unsigned int	numberOfSamples () const
bool	operator== (const TotemTimingDigi &digi) const
	Digis are equal if they have all the same values, NOT checking the samples! More...
int	sampleAt (const unsigned int i) const
std::vector< uint8_t >	samples () const
std::vector< uint8_t >::const_iterator	samplesBegin () const
std::vector< uint8_t >::const_iterator	samplesEnd () const
void	setCellInfo (const uint16_t cellInfo)
void	setEventInfo (const TotemTimingEventInfo &totemTimingEventInfo)
void	setFPGATimestamp (const uint64_t fpgaTimestamp)
void	setHardwareBoardId (const unsigned int boardId)
void	setHardwareChannelId (const unsigned int channelId)
void	setHardwareId (const uint8_t hwId)
void	setHardwareSampicId (const unsigned int sampicId)
void	setSampleAt (const unsigned int i, const uint8_t sampleValue)
void	setSamples (const std::vector< uint8_t > &samples)
void	setTimestampA (const uint16_t timestampA)
void	setTimestampB (const uint16_t timestampB)
unsigned int	timestampA () const
unsigned int	timestampB () const
	TotemTimingDigi ()
	TotemTimingDigi (const TotemTimingDigi &digi)
	TotemTimingDigi (const uint8_t hwId, const uint64_t fpgaTimestamp, const uint16_t timestampA, const uint16_t timestampB, const uint16_t cellInfo, const std::vector< uint8_t > &samples, const TotemTimingEventInfo &totemTimingEventInfo)
	~TotemTimingDigi ()

Private Attributes
uint16_t	cellInfo_
uint64_t	fpgaTimestamp_
uint8_t	hwId_
std::vector< uint8_t >	samples_
uint16_t	timestampA_
uint16_t	timestampB_
TotemTimingEventInfo	totemTimingEventInfo_

Detailed Description

Digi Class for CTPPS Timing Detector

Author

Mirko Berretti

Nicola Minafra

Laurent Forthomme March 2018

Definition at line 19 of file TotemTimingDigi.h.

Constructor & Destructor Documentation

TotemTimingDigi() [1/3]

TotemTimingDigi::TotemTimingDigi	(	const uint8_t	hwId,
		const uint64_t	fpgaTimestamp,
		const uint16_t	timestampA,
		const uint16_t	timestampB,
		const uint16_t	cellInfo,
		const std::vector< uint8_t > &	samples,
		const TotemTimingEventInfo &	totemTimingEventInfo
	)

Definition at line 10 of file TotemTimingDigi.cc.

    : hwId_(hwId),
      fpgaTimestamp_(fpgaTimestamp),
      timestampA_(timestampA),
      timestampB_(timestampB),
      cellInfo_(cellInfo),
      samples_(samples),
      totemTimingEventInfo_(totemTimingEventInfo) {}

TotemTimingDigi() [2/3]

TotemTimingDigi::TotemTimingDigi

(

const TotemTimingDigi &

digi

)

Definition at line 25 of file TotemTimingDigi.cc.

    : hwId_(digi.hwId_),
      fpgaTimestamp_(digi.fpgaTimestamp_),
      timestampA_(digi.timestampA_),
      timestampB_(digi.timestampB_),
      cellInfo_(digi.cellInfo_),
      samples_(digi.samples_),
      totemTimingEventInfo_(digi.totemTimingEventInfo_) {}

TotemTimingDigi() [3/3]

TotemTimingDigi::TotemTimingDigi

(

)

Definition at line 34 of file TotemTimingDigi.cc.

: hwId_(0), fpgaTimestamp_(0), timestampA_(0), timestampB_(0), cellInfo_(0) {}

~TotemTimingDigi()

TotemTimingDigi::~TotemTimingDigi ( )

inline

Definition at line 30 of file TotemTimingDigi.h.

{};

Member Function Documentation

addSample()

void TotemTimingDigi::addSample ( const uint8_t  sampleValue )

inline

Definition at line 100 of file TotemTimingDigi.h.

{ samples_.emplace_back(sampleValue); }

References samples_.

cellInfo()

unsigned int TotemTimingDigi::cellInfo ( ) const

inline

Definition at line 52 of file TotemTimingDigi.h.

{ return cellInfo_; }

References cellInfo_.

Referenced by operator<<(), setCellInfo(), TotemTimingConversions::timeOfFirstSample(), and TotemTimingConversions::voltSamples().

eventInfo()

TotemTimingEventInfo TotemTimingDigi::eventInfo ( ) const

inline

Definition at line 69 of file TotemTimingDigi.h.

{ return totemTimingEventInfo_; }

References totemTimingEventInfo_.

Referenced by operator<<(), TotemTimingConversions::timeOfFirstSample(), and TotemTimingConversions::triggerTime().

fpgaTimestamp()

unsigned int TotemTimingDigi::fpgaTimestamp ( ) const

inline

Definition at line 46 of file TotemTimingDigi.h.

{ return fpgaTimestamp_; }

References fpgaTimestamp_.

Referenced by operator<<(), setFPGATimestamp(), and TotemTimingConversions::timeOfFirstSample().

hardwareBoardId()

unsigned int TotemTimingDigi::hardwareBoardId ( ) const

inline

Definition at line 40 of file TotemTimingDigi.h.

{ return (hwId_ & 0xE0) >> 5; }

References hwId_.

Referenced by operator<<(), TotemTimingConversions::timeOfFirstSample(), TotemTimingConversions::timePrecision(), and TotemTimingConversions::voltSamples().

hardwareChannelId()

unsigned int TotemTimingDigi::hardwareChannelId ( ) const

inline

Definition at line 44 of file TotemTimingDigi.h.

{ return (hwId_ & 0x0F); }

References hwId_.

Referenced by operator<<(), TotemTimingConversions::timeOfFirstSample(), TotemTimingConversions::timePrecision(), and TotemTimingConversions::voltSamples().

hardwareId()

unsigned int TotemTimingDigi::hardwareId ( ) const

inline

Return digi values number.

Hardware Id formatted as: bits 0-3 Channel Id, bit 4 Sampic Id, bits 5-7 Digitizer Board Id

Definition at line 38 of file TotemTimingDigi.h.

{ return hwId_; }

References hwId_.

Referenced by operator<<().

hardwareSampicId()

unsigned int TotemTimingDigi::hardwareSampicId ( ) const

inline

Definition at line 42 of file TotemTimingDigi.h.

{ return (hwId_ & 0x10) >> 4; }

References hwId_.

Referenced by operator<<(), TotemTimingConversions::timeOfFirstSample(), TotemTimingConversions::timePrecision(), and TotemTimingConversions::voltSamples().

numberOfSamples()

unsigned int TotemTimingDigi::numberOfSamples ( ) const

inline

Definition at line 60 of file TotemTimingDigi.h.

{ return samples_.size(); }

References samples_.

Referenced by operator<<(), and TotemTimingConversions::timeSamples().

operator==()

bool TotemTimingDigi::operator==

(

const TotemTimingDigi &

digi

)

const

Digis are equal if they have all the same values, NOT checking the samples!

Definition at line 37 of file TotemTimingDigi.cc.

                                                                  {
  if (hwId_ != digi.hwId_ || fpgaTimestamp_ != digi.fpgaTimestamp_ || timestampA_ != digi.timestampA_ ||
      timestampB_ != digi.timestampB_ || cellInfo_ != digi.cellInfo_ || samples_ != digi.samples_)
    return false;
  return true;
}

References cellInfo_, fpgaTimestamp_, hwId_, samples_, timestampA_, and timestampB_.

sampleAt()

int TotemTimingDigi::sampleAt ( const unsigned int  i ) const

inline

Definition at line 62 of file TotemTimingDigi.h.

                                                  {
    int sampleValue = -1;
    if (i < samples_.size())
      sampleValue = (int)samples_.at(i);
    return sampleValue;
  }

References mps_fire::i, and samples_.

samples()

std::vector<uint8_t> TotemTimingDigi::samples ( ) const

inline

Definition at line 54 of file TotemTimingDigi.h.

{ return samples_; }

References samples_.

Referenced by setSamples(), and TotemTimingConversions::voltSamples().

samplesBegin()

std::vector<uint8_t>::const_iterator TotemTimingDigi::samplesBegin ( ) const

inline

Definition at line 56 of file TotemTimingDigi.h.

{ return samples_.cbegin(); }

References samples_.

samplesEnd()

std::vector<uint8_t>::const_iterator TotemTimingDigi::samplesEnd ( ) const

inline

Definition at line 58 of file TotemTimingDigi.h.

{ return samples_.cend(); }

References samples_.

setCellInfo()

void TotemTimingDigi::setCellInfo ( const uint16_t  cellInfo )

inline

Definition at line 96 of file TotemTimingDigi.h.

{ cellInfo_ = cellInfo & 0x3F; }

References cellInfo(), and cellInfo_.

setEventInfo()

void TotemTimingDigi::setEventInfo ( const TotemTimingEventInfo &  totemTimingEventInfo )

inline

Definition at line 107 of file TotemTimingDigi.h.

                                                                             {
    totemTimingEventInfo_ = totemTimingEventInfo;
  }

References totemTimingEventInfo_.

setFPGATimestamp()

void TotemTimingDigi::setFPGATimestamp ( const uint64_t  fpgaTimestamp )

inline

Definition at line 90 of file TotemTimingDigi.h.

{ fpgaTimestamp_ = fpgaTimestamp; }

References fpgaTimestamp(), and fpgaTimestamp_.

setHardwareBoardId()

void TotemTimingDigi::setHardwareBoardId ( const unsigned int  boardId )

inline

Definition at line 75 of file TotemTimingDigi.h.

                                                             {
    hwId_ &= 0x1F;  // set board bits to 0
    hwId_ |= ((boardId & 0x07) << 5) & 0xE0;
  }

References amcDumpToRaw_cfi::boardId, and hwId_.

setHardwareChannelId()

void TotemTimingDigi::setHardwareChannelId ( const unsigned int  channelId )

inline

Definition at line 85 of file TotemTimingDigi.h.

                                                                 {
    hwId_ &= 0xF0;  // Set Sampic bit to 0
    hwId_ |= (channelId & 0x0F) & 0x0F;
  }

References hwId_.

setHardwareId()

void TotemTimingDigi::setHardwareId ( const uint8_t  hwId )

inline

Set digi values Hardware Id formatted as: bits 0-3 Channel Id, bit 4 Sampic Id, bits 5-7 Digitizer Board Id

Definition at line 73 of file TotemTimingDigi.h.

{ hwId_ = hwId; }

References hwId_.

setHardwareSampicId()

void TotemTimingDigi::setHardwareSampicId ( const unsigned int  sampicId )

inline

Definition at line 80 of file TotemTimingDigi.h.

                                                               {
    hwId_ &= 0xEF;  // set Sampic bit to 0
    hwId_ |= ((sampicId & 0x01) << 4) & 0x10;
  }

References hwId_.

setSampleAt()

void TotemTimingDigi::setSampleAt ( const unsigned int  i, const uint8_t  sampleValue  )

inline

Definition at line 102 of file TotemTimingDigi.h.

                                                                           {
    if (i < samples_.size())
      samples_.at(i) = sampleValue;
  }

References mps_fire::i, and samples_.

setSamples()

void TotemTimingDigi::setSamples ( const std::vector< uint8_t > &  samples )

inline

Definition at line 98 of file TotemTimingDigi.h.

{ samples_ = samples; }

References samples(), and samples_.

setTimestampA()

void TotemTimingDigi::setTimestampA ( const uint16_t  timestampA )

inline

Definition at line 92 of file TotemTimingDigi.h.

{ timestampA_ = timestampA; }

References timestampA(), and timestampA_.

setTimestampB()

void TotemTimingDigi::setTimestampB ( const uint16_t  timestampB )

inline

Definition at line 94 of file TotemTimingDigi.h.

{ timestampB_ = timestampB; }

References timestampB(), and timestampB_.

timestampA()

unsigned int TotemTimingDigi::timestampA ( ) const

inline

Definition at line 48 of file TotemTimingDigi.h.

{ return timestampA_; }

References timestampA_.

Referenced by operator<<(), setTimestampA(), and TotemTimingConversions::timeOfFirstSample().

timestampB()

unsigned int TotemTimingDigi::timestampB ( ) const

inline

Definition at line 50 of file TotemTimingDigi.h.

{ return timestampB_; }

References timestampB_.

Referenced by operator<<(), setTimestampB(), and TotemTimingConversions::timeOfFirstSample().

Member Data Documentation

cellInfo_

uint16_t TotemTimingDigi::cellInfo_

private

Definition at line 116 of file TotemTimingDigi.h.

Referenced by cellInfo(), operator==(), and setCellInfo().

fpgaTimestamp_

uint64_t TotemTimingDigi::fpgaTimestamp_

private

Definition at line 113 of file TotemTimingDigi.h.

Referenced by fpgaTimestamp(), operator==(), and setFPGATimestamp().

hwId_

uint8_t TotemTimingDigi::hwId_

private

Definition at line 112 of file TotemTimingDigi.h.

Referenced by hardwareBoardId(), hardwareChannelId(), hardwareId(), hardwareSampicId(), operator==(), setHardwareBoardId(), setHardwareChannelId(), setHardwareId(), and setHardwareSampicId().

samples_

std::vector<uint8_t> TotemTimingDigi::samples_

private

Definition at line 118 of file TotemTimingDigi.h.

Referenced by addSample(), numberOfSamples(), operator==(), sampleAt(), samples(), samplesBegin(), samplesEnd(), setSampleAt(), and setSamples().

timestampA_

uint16_t TotemTimingDigi::timestampA_

private

Definition at line 114 of file TotemTimingDigi.h.

Referenced by operator==(), setTimestampA(), and timestampA().

timestampB_

uint16_t TotemTimingDigi::timestampB_

private

Definition at line 115 of file TotemTimingDigi.h.

Referenced by operator==(), setTimestampB(), and timestampB().

totemTimingEventInfo_

TotemTimingEventInfo TotemTimingDigi::totemTimingEventInfo_

private

Definition at line 120 of file TotemTimingDigi.h.

Referenced by eventInfo(), and setEventInfo().