o2::phos::RCUTrailer Class Reference

Information stored in the RCU trailer. More...

#include <RCUTrailer.h>

Classes
class	Error
	Error handling of the. More...

Public Member Functions
	RCUTrailer ()=default
	Constructor.
	RCUTrailer (const gsl::span< const uint32_t > payloadwords)
	~RCUTrailer ()=default
	destructor
void	reset ()
	Reset the RCU trailer.
void	printStream (std::ostream &stream) const
	Prints the contents of the RCU trailer data.
void	constructFromRawPayload (const gsl::span< const uint32_t > payloadwords)
	Decode RCU trailer from the 32-bit words in the raw buffer.
unsigned int	getFECErrorsA () const
unsigned int	getFECErrorsB () const
unsigned short	getErrorsG2 () const
unsigned int	getErrorsG3 () const
unsigned short	getActiveFECsA () const
unsigned short	getActiveFECsB () const
unsigned int	getAltroCFGReg1 () const
unsigned int	getAltroCFGReg2 () const
int	getRCUID () const
unsigned int	getTrailerSize () const
unsigned int	getPayloadSize () const
unsigned char	getFirmwareVersion () const
unsigned short	getNumberOfChannelAddressMismatch () const
unsigned short	getNumberOfChannelLengthMismatch () const
unsigned char	getBaselineCorrection () const
bool	getPolarity () const
unsigned char	getNumberOfPresamples () const
unsigned char	getNumberOfPostsamples () const
bool	hasSecondBaselineCorr () const
unsigned char	getGlitchFilter () const
unsigned char	getNumberOfNonZeroSuppressedPostsamples () const
unsigned char	getNumberOfNonZeroSuppressedPresamples () const
bool	hasZeroSuppression () const
bool	getNumberOfAltroBuffers () const
unsigned char	getNumberOfPretriggerSamples () const
unsigned short	getNumberOfSamplesPerChannel () const
bool	isSparseReadout () const
double	getTimeSample () const
	Access to the sampling time.
void	setTimeSample (double timesample)
	set time sample
double	getL1Phase () const
	Access to the L1 phase.
void	setL1Phase (double l1phase)
	Set the L1 phase.
void	setFECErrorsA (unsigned int value)
void	setFECErrorsB (unsigned int value)
void	setErrorsG2 (unsigned short value)
void	setErrorsG3 (unsigned int value)
void	setActiveFECsA (unsigned short value)
void	setActiveFECsB (unsigned short value)
void	setAltroCFGReg1 (unsigned int value)
void	setAltroCFGReg2 (unsigned int value)
void	setFirmwareVersion (unsigned char version)
void	setPayloadSize (unsigned int size)
bool	isInitialized () const
	checlks whether the RCU trailer is initialzied
std::vector< uint32_t >	encode () const

Static Public Member Functions
static RCUTrailer	constructFromPayloadWords (const gsl::span< const uint32_t > payloadwords)

Detailed Description

Information stored in the RCU trailer.

The RCU trailer can be found at the end of the payload and contains general information sent by the SRU.

Definition at line 55 of file RCUTrailer.h.

Constructor & Destructor Documentation

RCUTrailer() [1/2]

o2::phos::RCUTrailer::RCUTrailer ( )

default

Constructor.

RCUTrailer() [2/2]

RCUTrailer::RCUTrailer

(

const gsl::span< const uint32_t >

payloadwords

)

Definition at line 21 of file RCUTrailer.cxx.

~RCUTrailer()

o2::phos::RCUTrailer::~RCUTrailer ( )

default

destructor

Member Function Documentation

constructFromPayloadWords()

RCUTrailer RCUTrailer::constructFromPayloadWords ( const gsl::span< const uint32_t >  payloadwords )

static

Definition at line 239 of file RCUTrailer.cxx.

constructFromRawPayload()

void RCUTrailer::constructFromRawPayload

(

const gsl::span< const uint32_t >

payloadwords

)

Decode RCU trailer from the 32-bit words in the raw buffer.

Parameters

buffer

Raw buffer from which to read the trailer

Read the RCU trailer according to the RCU formware version specified in CDH.

Definition at line 43 of file RCUTrailer.cxx.

encode()

std::vector< uint32_t > RCUTrailer::encode

(

)

const

Definition at line 167 of file RCUTrailer.cxx.

getActiveFECsA()

unsigned short o2::phos::RCUTrailer::getActiveFECsA ( ) const

inline

Definition at line 124 of file RCUTrailer.h.

getActiveFECsB()

unsigned short o2::phos::RCUTrailer::getActiveFECsB ( ) const

inline

Definition at line 125 of file RCUTrailer.h.

getAltroCFGReg1()

unsigned int o2::phos::RCUTrailer::getAltroCFGReg1 ( ) const

inline

Definition at line 126 of file RCUTrailer.h.

getAltroCFGReg2()

unsigned int o2::phos::RCUTrailer::getAltroCFGReg2 ( ) const

inline

Definition at line 127 of file RCUTrailer.h.

getBaselineCorrection()

unsigned char o2::phos::RCUTrailer::getBaselineCorrection ( ) const

inline

Definition at line 135 of file RCUTrailer.h.

getErrorsG2()

unsigned short o2::phos::RCUTrailer::getErrorsG2 ( ) const

inline

Definition at line 122 of file RCUTrailer.h.

getErrorsG3()

unsigned int o2::phos::RCUTrailer::getErrorsG3 ( ) const

inline

Definition at line 123 of file RCUTrailer.h.

getFECErrorsA()

unsigned int o2::phos::RCUTrailer::getFECErrorsA ( ) const

inline

Definition at line 120 of file RCUTrailer.h.

getFECErrorsB()

unsigned int o2::phos::RCUTrailer::getFECErrorsB ( ) const

inline

Definition at line 121 of file RCUTrailer.h.

getFirmwareVersion()

unsigned char o2::phos::RCUTrailer::getFirmwareVersion ( ) const

inline

Definition at line 131 of file RCUTrailer.h.

getGlitchFilter()

unsigned char o2::phos::RCUTrailer::getGlitchFilter ( ) const

inline

Definition at line 140 of file RCUTrailer.h.

getL1Phase()

double RCUTrailer::getL1Phase

(

)

const

Access to the L1 phase.

Returns

L1 phase w.r.t to the LHC clock

Definition at line 151 of file RCUTrailer.cxx.

getNumberOfAltroBuffers()

bool o2::phos::RCUTrailer::getNumberOfAltroBuffers ( ) const

inline

Definition at line 144 of file RCUTrailer.h.

getNumberOfChannelAddressMismatch()

unsigned short o2::phos::RCUTrailer::getNumberOfChannelAddressMismatch ( ) const

inline

Definition at line 133 of file RCUTrailer.h.

getNumberOfChannelLengthMismatch()

unsigned short o2::phos::RCUTrailer::getNumberOfChannelLengthMismatch ( ) const

inline

Definition at line 134 of file RCUTrailer.h.

getNumberOfNonZeroSuppressedPostsamples()

unsigned char o2::phos::RCUTrailer::getNumberOfNonZeroSuppressedPostsamples ( ) const

inline

Definition at line 141 of file RCUTrailer.h.

getNumberOfNonZeroSuppressedPresamples()

unsigned char o2::phos::RCUTrailer::getNumberOfNonZeroSuppressedPresamples ( ) const

inline

Definition at line 142 of file RCUTrailer.h.

getNumberOfPostsamples()

unsigned char o2::phos::RCUTrailer::getNumberOfPostsamples ( ) const

inline

Definition at line 138 of file RCUTrailer.h.

getNumberOfPresamples()

unsigned char o2::phos::RCUTrailer::getNumberOfPresamples ( ) const

inline

Definition at line 137 of file RCUTrailer.h.

getNumberOfPretriggerSamples()

unsigned char o2::phos::RCUTrailer::getNumberOfPretriggerSamples ( ) const

inline

Definition at line 145 of file RCUTrailer.h.

getNumberOfSamplesPerChannel()

unsigned short o2::phos::RCUTrailer::getNumberOfSamplesPerChannel ( ) const

inline

Definition at line 146 of file RCUTrailer.h.

getPayloadSize()

unsigned int o2::phos::RCUTrailer::getPayloadSize ( ) const

inline

Definition at line 130 of file RCUTrailer.h.

getPolarity()

bool o2::phos::RCUTrailer::getPolarity ( ) const

inline

Definition at line 136 of file RCUTrailer.h.

getRCUID()

int o2::phos::RCUTrailer::getRCUID ( ) const

inline

Definition at line 128 of file RCUTrailer.h.

getTimeSample()

double RCUTrailer::getTimeSample

(

)

const

Access to the sampling time.

Returns

Sampling time in seconds.

Exceptions

Error

if the RCU trailer was not properly initializied

Definition at line 112 of file RCUTrailer.cxx.

getTrailerSize()

unsigned int o2::phos::RCUTrailer::getTrailerSize ( ) const

inline

Definition at line 129 of file RCUTrailer.h.

hasSecondBaselineCorr()

bool o2::phos::RCUTrailer::hasSecondBaselineCorr ( ) const

inline

Definition at line 139 of file RCUTrailer.h.

hasZeroSuppression()

bool o2::phos::RCUTrailer::hasZeroSuppression ( ) const

inline

Definition at line 143 of file RCUTrailer.h.

isInitialized()

bool o2::phos::RCUTrailer::isInitialized ( ) const

inline

checlks whether the RCU trailer is initialzied

Returns

True if the trailer is initialized, false otherwise

Definition at line 179 of file RCUTrailer.h.

isSparseReadout()

bool o2::phos::RCUTrailer::isSparseReadout ( ) const

inline

Definition at line 147 of file RCUTrailer.h.

printStream()

void RCUTrailer::printStream

(

std::ostream &

stream

)

const

Prints the contents of the RCU trailer data.

Parameters

stream

stream the trailer has to be put on

Definition at line 185 of file RCUTrailer.cxx.

reset()

void RCUTrailer::reset

(

)

Reset the RCU trailer.

Setting all values to 0

Definition at line 26 of file RCUTrailer.cxx.

setActiveFECsA()

void o2::phos::RCUTrailer::setActiveFECsA ( unsigned short  value )

inline

Definition at line 170 of file RCUTrailer.h.

setActiveFECsB()

void o2::phos::RCUTrailer::setActiveFECsB ( unsigned short  value )

inline

Definition at line 171 of file RCUTrailer.h.

setAltroCFGReg1()

void o2::phos::RCUTrailer::setAltroCFGReg1 ( unsigned int  value )

inline

Definition at line 172 of file RCUTrailer.h.

setAltroCFGReg2()

void o2::phos::RCUTrailer::setAltroCFGReg2 ( unsigned int  value )

inline

Definition at line 173 of file RCUTrailer.h.

setErrorsG2()

void o2::phos::RCUTrailer::setErrorsG2 ( unsigned short  value )

inline

Definition at line 168 of file RCUTrailer.h.

setErrorsG3()

void o2::phos::RCUTrailer::setErrorsG3 ( unsigned int  value )

inline

Definition at line 169 of file RCUTrailer.h.

setFECErrorsA()

void o2::phos::RCUTrailer::setFECErrorsA ( unsigned int  value )

inline

Definition at line 166 of file RCUTrailer.h.

setFECErrorsB()

void o2::phos::RCUTrailer::setFECErrorsB ( unsigned int  value )

inline

Definition at line 167 of file RCUTrailer.h.

setFirmwareVersion()

void o2::phos::RCUTrailer::setFirmwareVersion ( unsigned char  version )

inline

Definition at line 174 of file RCUTrailer.h.

setL1Phase()

void RCUTrailer::setL1Phase

(

double

l1phase

)

Set the L1 phase.

Parameters

l1phase

L1 phase (in ns)

Definition at line 161 of file RCUTrailer.cxx.

setPayloadSize()

void o2::phos::RCUTrailer::setPayloadSize ( unsigned int  size )

inline

Definition at line 175 of file RCUTrailer.h.

setTimeSample()

void RCUTrailer::setTimeSample

(

double

timesample

)

set time sample

Parameters

timesample

Time sample (in ns)

Definition at line 136 of file RCUTrailer.cxx.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/PHOS/base/include/PHOSBase/RCUTrailer.h
• /home/runner/work/AliceO2/AliceO2/Detectors/PHOS/base/src/RCUTrailer.cxx