PXDDAQStatus Class Reference

The PXD DAQ Status class. More...

#include <PXDDAQStatus.h>

Inheritance diagram for PXDDAQStatus:

Collaboration diagram for PXDDAQStatus:

Public Member Functions
	PXDDAQStatus ()
	Default constructor for the ROOT IO.
	PXDDAQStatus (PXDErrorFlags mask)
	constructor setting the error mask. More...
const PXDDAQDHEStatus *	findDHE (const VxdID &id) const
	Return pointer to PXDDAQDHEStatus for the DHE connected to sensor with VxdID id If id not found, it returns nullptr! More...
bool	isUsable () const
	Return Usability of data. More...
void	setUnfiltered (bool b)
	Set flag that data was recorded without ROI filtering. More...
bool	isUnfiltered () const
	Return if data was recorded without ROI filtering. More...
void	setGated (bool b)
	Set flag that data was while detector was gated. More...
bool	isGated () const
	Return if data was recorded while detector was gated. More...
void	setErrorMask (PXDErrorFlags m)
	Set Error bit mask This should be the OR of error masks of all sub-objects (DHC, DHE) More...
void	addErrorMask (PXDErrorFlags m)
	Add (OR) Error bit mask This should be the OR of error masks of all sub-objects (DHC, DHE) More...
PXDErrorFlags	getErrorMask (void) const
	Return Error bit mask This is the OR of error masks of all sub-objects (DHC, DHE) 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, or the sensor was gated, the PXD data is not usable for analysis TODO Maybe this decision needs improvement.
void	addPacket (PXDDAQPacketStatus &daqpktstat)
	Add Data packet information including its DHC/DHE tree. More...
template<class ... Args>
PXDDAQPacketStatus &	newPacket (Args &&... params)
	Add new Packet information. More...
std::map< VxdID, bool >	getUsable () const
	Return map of module usability. More...
std::vector< PXDDAQPacketStatus >::iterator	begin ()
	iterator-based iteration for packets
std::vector< PXDDAQPacketStatus >::iterator	end ()
	iterator-based iteration for packets
std::vector< PXDDAQPacketStatus >::const_iterator	cbegin () const
	const iterator-based iteration for packets
std::vector< PXDDAQPacketStatus >::const_iterator	cend () const
	const iterator-based iteration for packets
PXDDAQPacketStatus &	pkt_back ()
	Returns PXDDAQPacketStatus for last packet in this event
size_t	pkt_size () const
	Returns number of packets in this event

Private Attributes
PXDErrorFlags	m_errorMask
	errors found in any packet/DHC/DHE
PXDErrorFlags	m_critErrorMask
	critical error mask
bool	m_usable
	Data is useable.
bool	m_gated
	Sensor was in gated mode.
bool	m_unfiltered
	Data was not ROI filtered.
std::vector< PXDDAQPacketStatus >	m_pxdPacket
	Vector of packet informations beloning to this event.

Detailed Description

The PXD DAQ Status class.

This is a small class that records information about PXD DAQ status It will record if the data of PXD is useable. In a tree structure, additional information per packet, DHC and DHE is stored. This preserves information which would normally get lost during unpacking

Definition at line 45 of file PXDDAQStatus.h.

Constructor & Destructor Documentation

PXDDAQStatus()

PXDDAQStatus ( PXDErrorFlags  mask )

inlineexplicit

constructor setting the error mask.

Parameters

mask	Error mask

Definition at line 54 of file PXDDAQStatus.h.

                          { return m_usable; }

Member Function Documentation

addErrorMask()

void addErrorMask ( PXDErrorFlags  m )

inline

Add (OR) Error bit mask This should be the OR of error masks of all sub-objects (DHC, DHE)

Parameters

m	Bit Mask to add (or)

Definition at line 98 of file PXDDAQStatus.h.

addPacket()

void addPacket ( PXDDAQPacketStatus &  daqpktstat )

inline

Add Data packet information including its DHC/DHE tree.

Parameters

daqpktstat

Packet Status Object

Definition at line 126 of file PXDDAQStatus.h.

findDHE()

const PXDDAQDHEStatus * findDHE

(

const VxdID &

id

)

const

Return pointer to PXDDAQDHEStatus for the DHE connected to sensor with VxdID id If id not found, it returns nullptr!

Parameters

id	VxdID for required DHE

Definition at line 17 of file PXDDAQStatus.cc.

{
  for (auto& pkt : m_pxdPacket) {
    for (auto it_dhc = pkt.cbegin(); it_dhc != pkt.cend(); ++it_dhc) {
      for (auto it_dhe = it_dhc->cbegin(); it_dhe != it_dhc->cend(); ++it_dhe) {
        if (it_dhe->getSensorID() == id) {
          return &(*it_dhe);
        }
      }
    }
  }
  return nullptr;
}

getCritErrorMask()

PXDErrorFlags getCritErrorMask ( void  ) const

inline

Return Critical Error bit mask.

Returns

bit mask

Definition at line 114 of file PXDDAQStatus.h.

getErrorMask()

PXDErrorFlags getErrorMask ( void  ) const

inline

Return Error bit mask This is the OR of error masks of all sub-objects (DHC, DHE)

Returns

bit mask

Definition at line 104 of file PXDDAQStatus.h.

getUsable()

std::map< VxdID, bool > getUsable

(

)

const

Return map of module usability.

Returns

map of VxdID with usable flags

Definition at line 31 of file PXDDAQStatus.cc.

isGated()

bool isGated ( ) const

inline

Return if data was recorded while detector was gated.

Returns

detector was gated

Definition at line 86 of file PXDDAQStatus.h.

isUnfiltered()

bool isUnfiltered ( ) const

inline

Return if data was recorded without ROI filtering.

Returns

data was not ROI filtered flag

Definition at line 76 of file PXDDAQStatus.h.

isUsable()

bool isUsable ( ) const

inline

Return Usability of data.

Returns

conclusion if data is useable

Definition at line 66 of file PXDDAQStatus.h.

newPacket()

PXDDAQPacketStatus& newPacket ( Args &&...  params )

inline

Add new Packet information.

Parameters

params

constructor parameter

Returns

ref to new Packet Status Object

Definition at line 132 of file PXDDAQStatus.h.

setCritErrorMask()

void setCritErrorMask ( PXDErrorFlags  m )

inline

Set Critical Error bit mask.

Parameters

m	Bit Mask to set

Definition at line 109 of file PXDDAQStatus.h.

setErrorMask()

void setErrorMask ( PXDErrorFlags  m )

inline

Set Error bit mask This should be the OR of error masks of all sub-objects (DHC, DHE)

Parameters

m	Bit Mask to set

Definition at line 92 of file PXDDAQStatus.h.

setGated()

void setGated ( bool  b )

inline

Set flag that data was while detector was gated.

Parameters

b

gated

Definition at line 81 of file PXDDAQStatus.h.

setUnfiltered()

void setUnfiltered ( bool  b )

inline

Set flag that data was recorded without ROI filtering.

Parameters

b	unfiltered

Definition at line 71 of file PXDDAQStatus.h.

---

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

• pxd/dataobjects/include/PXDDAQStatus.h
• pxd/dataobjects/src/PXDDAQStatus.cc