Project
Loading...
Searching...
No Matches
Public Member Functions | List of all members
o2::mch::ROFRecord Class Reference

#include <ROFRecord.h>

Public Member Functions

 ROFRecord ()=default
 
 ROFRecord (const BCData &bc, int firstIdx, int nEntries)
 
 ROFRecord (const BCData &bc, int firstIdx, int nEntries, int bcWidth)
 
const BCData & getBCData () const
 get the interaction record
 
BCData & getBCData ()
 get the interaction record
 
void setBCData (const BCData &bc)
 set the interaction record
 
std::pair< Time, bool > getTimeMUS (const BCData &startIR, uint32_t nOrbits=128, bool printError=false) const
 
int getNEntries () const
 get the number of associated objects
 
int getFirstIdx () const
 get the index of the first associated object
 
int getLastIdx () const
 get the index of the last associated object
 
void setDataRef (int firstIdx, int nEntries)
 set the number of associated objects and the index of the first one
 
int getBCWidth () const
 get the time span by this ROF, in BC unit
 
bool operator== (const ROFRecord &other) const
 
bool operator!= (const ROFRecord &other) const
 
bool operator< (const ROFRecord &other) const
 

Detailed Description

ROFRecord class encodes the trigger interaction record of a given ROF and the location of the associated objects (digit, cluster, etc) in the data container

Definition at line 34 of file ROFRecord.h.

Constructor & Destructor Documentation

◆ ROFRecord() [1/3]

o2::mch::ROFRecord::ROFRecord ( )
default

◆ ROFRecord() [2/3]

o2::mch::ROFRecord::ROFRecord ( const BCData &  bc,
int  firstIdx,
int  nEntries 
)
inline

Definition at line 42 of file ROFRecord.h.

◆ ROFRecord() [3/3]

o2::mch::ROFRecord::ROFRecord ( const BCData &  bc,
int  firstIdx,
int  nEntries,
int  bcWidth 
)
inline

Definition at line 43 of file ROFRecord.h.

Member Function Documentation

◆ getBCData() [1/2]

BCData & o2::mch::ROFRecord::getBCData ( )
inline

get the interaction record

Definition at line 48 of file ROFRecord.h.

◆ getBCData() [2/2]

const BCData & o2::mch::ROFRecord::getBCData ( ) const
inline

get the interaction record

Definition at line 46 of file ROFRecord.h.

◆ getBCWidth()

int o2::mch::ROFRecord::getBCWidth ( ) const
inline

get the time span by this ROF, in BC unit

Definition at line 64 of file ROFRecord.h.

◆ getFirstIdx()

int o2::mch::ROFRecord::getFirstIdx ( ) const
inline

get the index of the first associated object

Definition at line 57 of file ROFRecord.h.

◆ getLastIdx()

int o2::mch::ROFRecord::getLastIdx ( ) const
inline

get the index of the last associated object

Definition at line 59 of file ROFRecord.h.

◆ getNEntries()

int o2::mch::ROFRecord::getNEntries ( ) const
inline

get the number of associated objects

Definition at line 55 of file ROFRecord.h.

◆ getTimeMUS()

std::pair< ROFRecord::Time, bool > o2::mch::ROFRecord::getTimeMUS ( const BCData &  startIR,
uint32_t  nOrbits = 128,
bool  printError = false 
) const

return a pair consisting of the ROF time with error (in mus) relative to the reference IR 'startIR' and a flag telling if it is inside the TF starting at 'startIR' and containing 'nOrbits' orbits. if printError = true, print an error message in case the ROF is outside the TF

Definition at line 35 of file ROFRecord.cxx.

◆ operator!=()

bool o2::mch::ROFRecord::operator!= ( const ROFRecord &  other) const
inline

Definition at line 72 of file ROFRecord.h.

◆ operator<()

bool o2::mch::ROFRecord::operator< ( const ROFRecord &  other) const
inline

Definition at line 73 of file ROFRecord.h.

◆ operator==()

bool o2::mch::ROFRecord::operator== ( const ROFRecord &  other) const
inline

Definition at line 66 of file ROFRecord.h.

◆ setBCData()

void o2::mch::ROFRecord::setBCData ( const BCData &  bc)
inline

set the interaction record

Definition at line 50 of file ROFRecord.h.

◆ setDataRef()

void o2::mch::ROFRecord::setDataRef ( int  firstIdx,
int  nEntries 
)
inline

set the number of associated objects and the index of the first one

Definition at line 61 of file ROFRecord.h.

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