PXDDAQPacketStatus Class Reference

The PXD DAQ Packet Status class. More...

#include <PXDDAQPacketStatus.h>

Collaboration diagram for PXDDAQPacketStatus:

Public Member Functions
	PXDDAQPacketStatus ()
	Default constructor for the ROOT IO.
	PXDDAQPacketStatus (unsigned short inx)
	constructor setting the error mask and packet index. More...
virtual	~PXDDAQPacketStatus ()
	destructor
bool	isUsable () const
	Return Usability of data. More...
void	setErrorMask (const PXDErrorFlags &mask)
	Set 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 (const PXDErrorFlags &mask)
	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 packet is not usable for analysis TODO Maybe this decision needs improvement.
void	setPktIndex (unsigned short inx)
	Set Packet index. More...
unsigned short	getPktIndex (void) const
	Return Packet index. More...
void	addDHC (PXDDAQDHCStatus &daqdhcstat)
	Add DHC information including its DHE tree. More...
template<class ... Args>
PXDDAQDHCStatus &	newDHC (Args &&... params)
	Add new DHC information. More...
std::vector< PXDDAQDHCStatus >::iterator	begin ()
	iterator-based iteration for DHCs
std::vector< PXDDAQDHCStatus >::iterator	end ()
	iterator-based iteration for DHCs
std::vector< PXDDAQDHCStatus >::const_iterator	cbegin () const
	const iterator-based iteration for DHCs
std::vector< PXDDAQDHCStatus >::const_iterator	cend () const
	const iterator-based iteration for DHCs
PXDDAQDHCStatus &	dhc_back ()
	Returns PXDDAQDHCStatus for last DHC.
size_t	dhc_size () const
	Returns number of DHCs.

Private Member Functions
	ClassDef (PXDDAQPacketStatus, 3)
	necessary for ROOT

Private Attributes
PXDErrorFlags	m_errorMask
	errors found in this packets sensors
PXDErrorFlags	m_critErrorMask
	critical error mask
bool	m_usable
	data is useable.
unsigned short	m_index
	Packet index as delivered by DAQ.
std::vector< PXDDAQDHCStatus >	m_pxdDHC
	Vector of DHC informations beloning to this event.

Detailed Description

The PXD DAQ Packet Status class.

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

Definition at line 30 of file PXDDAQPacketStatus.h.

Constructor & Destructor Documentation

PXDDAQPacketStatus()

PXDDAQPacketStatus ( unsigned short  inx )

inlineexplicit

constructor setting the error mask and packet index.

Parameters

inx	packet index

Definition at line 39 of file PXDDAQPacketStatus.h.

: m_errorMask(0), m_critErrorMask(0), m_usable(true), m_index(inx) {}

Member Function Documentation

addDHC()

void addDHC ( PXDDAQDHCStatus &  daqdhcstat )

inline

Add DHC information including its DHE tree.

Parameters

daqdhcstat

DHC Status Object

Definition at line 91 of file PXDDAQPacketStatus.h.

getCritErrorMask()

PXDErrorFlags getCritErrorMask ( void  ) const

inline

Return Critical Error bit mask.

Returns

bit mask

Definition at line 69 of file PXDDAQPacketStatus.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 59 of file PXDDAQPacketStatus.h.

getPktIndex()

unsigned short getPktIndex ( void  ) const

inline

Return Packet index.

Returns

packet index

Definition at line 86 of file PXDDAQPacketStatus.h.

isUsable()

bool isUsable ( ) const

inline

Return Usability of data.

Returns

conclusion if data is useable

Definition at line 47 of file PXDDAQPacketStatus.h.

newDHC()

PXDDAQDHCStatus& newDHC ( Args &&...  params )

inline

Add new DHC information.

Parameters

params

constructor parameter

Returns

ref to new DHC Status Object

Definition at line 97 of file PXDDAQPacketStatus.h.

setCritErrorMask()

void setCritErrorMask ( const PXDErrorFlags &  mask )

inline

Set Critical Error bit mask.

Parameters

mask	Bit Mask to set

Definition at line 64 of file PXDDAQPacketStatus.h.

setErrorMask()

void setErrorMask ( const PXDErrorFlags &  mask )

inline

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

Parameters

mask	Bit Mask to set

Definition at line 53 of file PXDDAQPacketStatus.h.

setPktIndex()

void setPktIndex ( unsigned short  inx )

inline

Set Packet index.

Parameters

inx	packet index

Definition at line 81 of file PXDDAQPacketStatus.h.

---

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

• pxd/dataobjects/include/PXDDAQPacketStatus.h