MuCTPI_Phase1_RDO Class Reference

Class representing the readout data of the MuCTPI hardware and simulation. More...

#include <MuCTPI_Phase1_RDO.h>

Collaboration diagram for MuCTPI_Phase1_RDO:

Public Member Functions
	MuCTPI_Phase1_RDO (std::vector< LVL1::MuCTPIBits::Slice > &&slices, std::vector< size_t > &&errorBits)
	This constructor can be used to fill the object with a vector of Slice structs and a vector of errorBits. More...
	MuCTPI_Phase1_RDO ()=default
	Default constructor. More...
	~MuCTPI_Phase1_RDO ()=default
	Destructor. More...
const std::vector< LVL1::MuCTPIBits::Slice > &	slices () const
	Function returning the timeslice data words. More...
const std::vector< size_t > &	errorBits () const
	Function returning the fragment error bits vector. More...

Private Attributes
std::vector< LVL1::MuCTPIBits::Slice >	m_slices
	Variable storing the timeslices read out. More...
std::vector< size_t >	m_errorBits
	Variable storing the erorrBits read out. More...

Detailed Description

Class representing the readout data of the MuCTPI hardware and simulation.

   The MuCTPI hardware and the simulation can send all the muon candidates
   recevied in a maximal window spanning +-3 BCs around the triggered BC
   (giving a window of maximally 5 BCs) together with the muon multiplicities
   in the same window to the readout system. This class represents the ROD
   fragment generated by the MuCTPI to Athena.

   For a detailed description of the data format of the MuCTPI, see
   the MUCTPI documentation (https://edms.cern.ch/file/2712287/1/Readout-Data-Format.xlsx).

See also

LVL1MUCTPI::L1Muctpi

MuCTPIByteStreamCnv

Definition at line 36 of file MuCTPI_Phase1_RDO.h.

Constructor & Destructor Documentation

MuCTPI_Phase1_RDO() [1/2]

MuCTPI_Phase1_RDO::MuCTPI_Phase1_RDO ( std::vector< LVL1::MuCTPIBits::Slice > &&  slices, std::vector< size_t > &&  errorBits  )

inline

This constructor can be used to fill the object with a vector of Slice structs and a vector of errorBits.

Parameters

slices	A vector of Slice objects, each including the decoded information
errorBits	A vector of bool values, corresponding to the last payload word in the MUCTPI DAQ format

Definition at line 45 of file MuCTPI_Phase1_RDO.h.

      : m_slices( std::move(slices) ),
        m_errorBits( std::move(errorBits) ) {
    }

MuCTPI_Phase1_RDO() [2/2]

MuCTPI_Phase1_RDO::MuCTPI_Phase1_RDO ( )

default

Default constructor.

A parameter-less constructor to be able to use the class with POOL.

~MuCTPI_Phase1_RDO()

MuCTPI_Phase1_RDO::~MuCTPI_Phase1_RDO ( )

default

Destructor.

The destructor doesn't really have to do anything.

Member Function Documentation

errorBits()

const std::vector< size_t >& MuCTPI_Phase1_RDO::errorBits ( ) const

inline

Function returning the fragment error bits vector.

The last MUCTPI payload data word contains errorBits related to the event.

Returns

A vector of all the error bits noted in the last payload word of the fragment. They are defined in the MUCTPI data format.

Definition at line 77 of file MuCTPI_Phase1_RDO.h.

{ return m_errorBits; }

slices()

const std::vector< LVL1::MuCTPIBits::Slice >& MuCTPI_Phase1_RDO::slices ( ) const

inline

Function returning the timeslice data words.

The MUCTPI data words are grouped in timeslices. Each timeslice has a header, a set of multiplicity words, N candidate words and M TOB words

Returns

A vector of all the slices

Definition at line 69 of file MuCTPI_Phase1_RDO.h.

{ return m_slices; }

Member Data Documentation

m_errorBits

std::vector< size_t > MuCTPI_Phase1_RDO::m_errorBits

private

Variable storing the erorrBits read out.

Definition at line 83 of file MuCTPI_Phase1_RDO.h.

m_slices

std::vector< LVL1::MuCTPIBits::Slice > MuCTPI_Phase1_RDO::m_slices

private

Variable storing the timeslices read out.

Definition at line 81 of file MuCTPI_Phase1_RDO.h.

---

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

• MuCTPI_Phase1_RDO.h