Belle II Software  release-05-02-19
PXDDAQDHEStatus Class Reference

The PXD DAQ DHE Status class. More...

#include <PXDDAQDHEStatus.h>

Collaboration diagram for PXDDAQDHEStatus:

Public Member Functions

 PXDDAQDHEStatus ()
 Default constructor for the ROOT IO.
 
 PXDDAQDHEStatus (VxdID id, int dheid, PXDErrorFlags mask, unsigned short tg, unsigned short fn)
 constructor setting the error mask, dheid, raw and reduced data counters, ... More...
 
bool isUsable () const
 Return Usability of data. More...
 
void markUnusable ()
 Mark Data in DHE as Unusable.
 
void setErrorMask (PXDErrorFlags m)
 Set Error bit mask. More...
 
PXDErrorFlags getErrorMask (void) const
 Return Error bit mask. More...
 
void setCritErrorMask (PXDErrorFlags m)
 Set Critical Error bit mask. More...
 
PXDErrorFlags getCritErrorMask (void) const
 Return Critical Error bit mask. More...
 
void Decide (void)
 Calculate the usability decision If any of the critical bits is set in the error mask the PXD data from this DHE is not usable for analysis TODO Maybe this decision needs improvement.
 
void setDHEID (VxdID id, int dheid)
 Set VxdID and DHE ID of sensor.
 
unsigned short getDHEID (void) const
 Get DHE ID of sensor.
 
VxdID getSensorID (void) const
 Get VxdID of sensor.
 
void setCounters (uint32_t raw, uint32_t red)
 Set Data counters for reduction calculation.
 
void getCounters (uint32_t &raw, uint32_t &red) const
 Get Data counters for reduction calculation.
 
uint32_t getRawCnt (void) const
 Set Raw Data counter for reduction calculation.
 
uint32_t getRedCnt (void) const
 Set Reduced Data counter for reduction calculation.
 
void setTriggerGate (unsigned int tg)
 set Trigger Gate
 
unsigned short getTriggerGate (void) const
 get Trigger Gate
 
unsigned short getStartRow (void) const
 get Trigger Start Row
 
void setFrameNr (unsigned int fn)
 set Readout Frame number
 
unsigned short getFrameNr (void) const
 get Readout Frame number
 
unsigned short getDHPFoundMask (void)
 get Mask for found DHPs with valid data
 
void setDHPFoundMask (unsigned short dhpmask)
 set Mask for found DHPs with valid data
 
void setEndErrorInfo (uint32_t e)
 set erroinfo from the DHE END
 
uint32_t getEndErrorInfo (void) const
 get erroinfo from the DHE END
 
void addDHP (PXDDAQDHPStatus &daqdhp)
 Add DHP information. More...
 
template<class ... Args>
PXDDAQDHPStatusnewDHP (Args &&... params)
 New DHP information. More...
 
std::vector< PXDDAQDHPStatus >::iterator begin ()
 iterator-based iteration for DHPs
 
std::vector< PXDDAQDHPStatus >::iterator end ()
 iterator-based iteration for DHPs
 
std::vector< PXDDAQDHPStatus >::const_iterator cbegin () const
 const iterator-based iteration for DHPs
 
std::vector< PXDDAQDHPStatus >::const_iterator cend () const
 const iterator-based iteration for DHPs
 
PXDDAQDHPStatusdhp_back ()
 Returns PXDDAQDHPStatus for the last DHP.
 
size_t dhp_size () const
 Returns number of DHPs.
 
auto addCM (PXDDAQDHPComMode &daqcm)
 Add Common Mode information. More...
 
std::vector< PXDDAQDHPComMode >::iterator cm_begin ()
 iterator-based iteration for Common Mode
 
std::vector< PXDDAQDHPComMode >::iterator cm_end ()
 iterator-based iteration for Common Mode
 
PXDDAQDHPComModecm_back ()
 Returns last Common Mode for this event.
 
size_t cm_size () const
 Returns number of Common Mode blocks in this event.
 
int get_cm_dhp (int i) const
 Returns CM DHP ID at position i.
 
int get_cm_row (int i) const
 Returns CM row at position i.
 
int get_cm_value (int i) const
 Returns CM value at position i.
 

Private Member Functions

 ClassDef (PXDDAQDHEStatus, 7)
 necessary for ROOT
 

Private Attributes

PXDErrorFlags m_errorMask
 errors found in this DHE/sensor
 
PXDErrorFlags m_critErrorMask
 critical error mask
 
bool m_usable
 data is useable.
 
unsigned short m_sensorID
 Sensor ID.
 
unsigned short m_dheID
 DHE ID as delivered by DAQ.
 
unsigned short m_triggerGate
 Trigger Gate ("Startrow") from DHE header.
 
unsigned short m_frameNr
 Frame number (low bits) from DHE header.
 
unsigned short m_dhp_found_mask
 Mask for DHP with valid data.
 
uint32_t m_rawCount
 raw byte count for monitoring
 
uint32_t m_redCount
 reduced byte count for monitoring
 
uint32_t m_errorinfo
 erroinfo from the DHE END
 
std::vector< PXDDAQDHPStatusm_pxdDHP
 Vector of DHP informations belonging to this event.
 
std::vector< PXDDAQDHPComModem_commode
 Vector of Common Mode informations belonging to this event.
 

Detailed Description

The PXD DAQ DHE Status class.

This is a small class that records information about PXD DAQ DHE status It will record if the data of this sensor (readout by this DHE) is useable.

Definition at line 46 of file PXDDAQDHEStatus.h.

Constructor & Destructor Documentation

◆ PXDDAQDHEStatus()

PXDDAQDHEStatus ( VxdID  id,
int  dheid,
PXDErrorFlags  mask,
unsigned short  tg,
unsigned short  fn 
)
inline

constructor setting the error mask, dheid, raw and reduced data counters, ...

Parameters
idVxdID of sensor
dheidDHEID of sensor
maskError mask
tgTrigger Gate (Start Row, Trigger Offset)
fn(absolute) Readout Frame Number, lower bits only

Definition at line 61 of file PXDDAQDHEStatus.h.

64  { m_usable = false; m_errorMask |= EPXDErrMask::c_UNUSABLE_DATA;}

Member Function Documentation

◆ addCM()

auto addCM ( PXDDAQDHPComMode daqcm)
inline

Add Common Mode information.

Parameters
daqcmDHP Common Mode object

Definition at line 171 of file PXDDAQDHEStatus.h.

◆ addDHP()

void addDHP ( PXDDAQDHPStatus daqdhp)
inline

Add DHP information.

Parameters
daqdhpDHP Status Object

Definition at line 142 of file PXDDAQDHEStatus.h.

◆ getCritErrorMask()

PXDErrorFlags getCritErrorMask ( void  ) const
inline

Return Critical Error bit mask.

Returns
bit mask

Definition at line 93 of file PXDDAQDHEStatus.h.

◆ getErrorMask()

PXDErrorFlags getErrorMask ( void  ) const
inline

Return Error bit mask.

Returns
bit mask

Definition at line 83 of file PXDDAQDHEStatus.h.

◆ isUsable()

bool isUsable ( ) const
inline

Return Usability of data.

Returns
conclusion if data is useable

Definition at line 69 of file PXDDAQDHEStatus.h.

◆ newDHP()

PXDDAQDHPStatus& newDHP ( Args &&...  params)
inline

New DHP information.

Parameters
paramsconstructor parameter
Returns
new DHP Status Object

Definition at line 148 of file PXDDAQDHEStatus.h.

◆ setCritErrorMask()

void setCritErrorMask ( PXDErrorFlags  m)
inline

Set Critical Error bit mask.

Parameters
mBit Mask to set

Definition at line 88 of file PXDDAQDHEStatus.h.

◆ setErrorMask()

void setErrorMask ( PXDErrorFlags  m)
inline

Set Error bit mask.

Parameters
mBit Mask to set

Definition at line 78 of file PXDDAQDHEStatus.h.


The documentation for this class was generated from the following file:
Belle2::PXDDAQDHEStatus::m_usable
bool m_usable
data is useable.
Definition: PXDDAQDHEStatus.h:191
Belle2::PXDDAQDHEStatus::m_errorMask
PXDErrorFlags m_errorMask
errors found in this DHE/sensor
Definition: PXDDAQDHEStatus.h:186