Project
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
o2::raw::RawFileWriter Class Reference

#include <RawFileWriter.h>

Classes

struct  DetLazinessCheck
 
struct  LinkData
 
struct  OutputFile
 
struct  PayloadCache
 ===================================================================================== More...
 

Public Types

using RDHAny = o2::header::RDHAny
 
using IR = o2::InteractionRecord
 
using CarryOverCallBack = std::function< int(const RDHAny *rdh, const gsl::span< char > data, const char *ptr, int size, int splitID, std::vector< char > &trailer, std::vector< char > &header)>
 
using EmptyPageCallBack = std::function< void(const RDHAny *rdh, std::vector< char > &emptyHBF)>
 
using NewRDHCallBack = std::function< void(const RDHAny *rdh, bool prevEmpty, std::vector< char > &filler)>
 

Public Member Functions

 RawFileWriter (o2::header::DataOrigin origin=o2::header::gDataOriginInvalid, bool cru=true)
 
 ~RawFileWriter ()
 
void useCaching ()
 
void doLazinessCheck (bool v)
 
void writeConfFile (std::string_view origin="FLP", std::string_view description="RAWDATA", std::string_view cfgname="raw.cfg", bool fullPath=true) const
 
void close ()
 
LinkData & registerLink (uint16_t fee, uint16_t cru, uint8_t link, uint8_t endpoint, std::string_view outFileName)
 
template<typename H >
LinkData & registerLink (const H &rdh, std::string_view outFileName)
 
void setOrigin (o2::header::DataOrigin origin)
 
o2::header::DataOrigin getOrigin () const
 
LinkData & getLinkWithSubSpec (LinkSubSpec_t ss)
 
template<typename H >
LinkData & getLinkWithSubSpec (const H &rdh)
 
void addData (uint16_t feeid, uint16_t cru, uint8_t lnk, uint8_t endpoint, const IR &ir, const gsl::span< char > data, bool preformatted=false, uint32_t trigger=0, uint32_t detField=0)
 
template<typename H >
void addData (const H &rdh, const IR &ir, const gsl::span< char > data, bool preformatted=false, uint32_t trigger=0)
 
void setContinuousReadout ()
 
void setTriggeredReadout ()
 
void setContinuousReadout (bool v)
 
bool isContinuousReadout () const
 
bool isTriggeredReadout () const
 
bool isReadOutModeSet () const
 
bool isLinkRegistered (LinkSubSpec_t ss) const
 
void setVerbosity (int v)
 
int getVerbosity () const
 
int getNOutputFiles () const
 
std::string getOutputFileName (int i) const
 
OutputFile & getOutputFileForLink (const LinkData &lnk)
 
int getSuperPageSize () const
 
void setSuperPageSize (int nbytes)
 
IR getIRMax () const
 get highest IR seen so far
 
const HBFUtils & getHBFUtils () const
 
template<class T >
void setCarryOverCallBack (const T *t)
 
template<class T >
void setEmptyPageCallBack (const T *t)
 
template<class T >
void setNewRDHCallBack (const T *t)
 
int carryOverMethod (const RDHAny *, const gsl::span< char > data, const char *ptr, int maxSize, int splitID, std::vector< char > &trailer, std::vector< char > &header) const
 
void emptyHBFMethod (const RDHAny *rdh, std::vector< char > &toAdd) const
 
void newRDHMethod (const RDHAny *rdh, bool prevEmpty, std::vector< char > &toAdd) const
 
int getUsedRDHVersion () const
 
void useRDHVersion (int v)
 
unsigned char getUsedRDHDataFormat () const
 
unsigned char getAlignmentSize () const
 
unsigned char getAlignmentPaddingFiller () const
 
void useRDHDataFormat (unsigned char v)
 
void setAlignmentSize (unsigned char v)
 
void setAlignmentPaddingFiller (unsigned char v)
 
bool getDontFillEmptyHBF () const
 
void setDontFillEmptyHBF (bool v)
 
bool getAddSeparateHBFStopPage () const
 
void setAddSeparateHBFStopPage (bool v)
 
void setRORCDetector ()
 
void setUseRDHStop (bool v=true)
 
void setApplyCarryOverToLastPage (bool v)
 
bool isRORCDetector () const
 
bool isCRUDetector () const
 
bool isRDHStopUsed () const
 
bool isCarryOverToLastPageApplied () const
 

Detailed Description

Definition at line 42 of file RawFileWriter.h.

Member Typedef Documentation

◆ CarryOverCallBack

using o2::raw::RawFileWriter::CarryOverCallBack = std::function<int(const RDHAny* rdh, const gsl::span<char> data, const char* ptr, int size, int splitID, std::vector<char>& trailer, std::vector<char>& header)>

Definition at line 48 of file RawFileWriter.h.

◆ EmptyPageCallBack

using o2::raw::RawFileWriter::EmptyPageCallBack = std::function<void(const RDHAny* rdh, std::vector<char>& emptyHBF)>

Definition at line 51 of file RawFileWriter.h.

◆ IR

using o2::raw::RawFileWriter::IR = o2::InteractionRecord

Definition at line 47 of file RawFileWriter.h.

◆ NewRDHCallBack

using o2::raw::RawFileWriter::NewRDHCallBack = std::function<void(const RDHAny* rdh, bool prevEmpty, std::vector<char>& filler)>

Definition at line 52 of file RawFileWriter.h.

◆ RDHAny

using o2::raw::RawFileWriter::RDHAny = o2::header::RDHAny

Definition at line 46 of file RawFileWriter.h.

Constructor & Destructor Documentation

◆ RawFileWriter()

o2::raw::RawFileWriter::RawFileWriter ( o2::header::DataOrigin  origin = o2::header::gDataOriginInvalid,
bool  cru = true 
)
inline

Definition at line 168 of file RawFileWriter.h.

◆ ~RawFileWriter()

RawFileWriter::~RawFileWriter ( )

Definition at line 32 of file RawFileWriter.cxx.

Member Function Documentation

◆ addData() [1/2]

template<typename H >
void o2::raw::RawFileWriter::addData ( const H &  rdh,
const IR &  ir,
const gsl::span< char >  data,
bool  preformatted = false,
uint32_t  trigger = 0 
)
inline

Definition at line 211 of file RawFileWriter.h.

◆ addData() [2/2]

void RawFileWriter::addData ( uint16_t  feeid,
uint16_t  cru,
uint8_t  lnk,
uint8_t  endpoint,
const IR &  ir,
const gsl::span< char >  data,
bool  preformatted = false,
uint32_t  trigger = 0,
uint32_t  detField = 0 
)

Definition at line 180 of file RawFileWriter.cxx.

◆ carryOverMethod()

int o2::raw::RawFileWriter::carryOverMethod ( const RDHAny *  ,
const gsl::span< char >  data,
const char *  ptr,
int  maxSize,
int  splitID,
std::vector< char > &  trailer,
std::vector< char > &  header 
) const
inline

Definition at line 323 of file RawFileWriter.h.

◆ close()

void RawFileWriter::close ( )

Definition at line 38 of file RawFileWriter.cxx.

◆ doLazinessCheck()

void o2::raw::RawFileWriter::doLazinessCheck ( bool  v)
inline

Definition at line 176 of file RawFileWriter.h.

◆ emptyHBFMethod()

void o2::raw::RawFileWriter::emptyHBFMethod ( const RDHAny *  rdh,
std::vector< char > &  toAdd 
) const
inline

Definition at line 336 of file RawFileWriter.h.

◆ getAddSeparateHBFStopPage()

bool o2::raw::RawFileWriter::getAddSeparateHBFStopPage ( ) const
inline

Definition at line 370 of file RawFileWriter.h.

◆ getAlignmentPaddingFiller()

unsigned char o2::raw::RawFileWriter::getAlignmentPaddingFiller ( ) const
inline

Definition at line 361 of file RawFileWriter.h.

◆ getAlignmentSize()

unsigned char o2::raw::RawFileWriter::getAlignmentSize ( ) const
inline

Definition at line 360 of file RawFileWriter.h.

◆ getDontFillEmptyHBF()

bool o2::raw::RawFileWriter::getDontFillEmptyHBF ( ) const
inline

Definition at line 367 of file RawFileWriter.h.

◆ getHBFUtils()

const HBFUtils & o2::raw::RawFileWriter::getHBFUtils ( ) const
inline

Definition at line 261 of file RawFileWriter.h.

◆ getIRMax()

IR RawFileWriter::getIRMax ( ) const

get highest IR seen so far

Definition at line 222 of file RawFileWriter.cxx.

◆ getLinkWithSubSpec() [1/2]

template<typename H >
LinkData & o2::raw::RawFileWriter::getLinkWithSubSpec ( const H &  rdh)
inline

Definition at line 201 of file RawFileWriter.h.

◆ getLinkWithSubSpec() [2/2]

RawFileWriter::LinkData & RawFileWriter::getLinkWithSubSpec ( LinkSubSpec_t  ss)

Definition at line 235 of file RawFileWriter.cxx.

◆ getNOutputFiles()

int o2::raw::RawFileWriter::getNOutputFiles ( ) const
inline

Definition at line 240 of file RawFileWriter.h.

◆ getOrigin()

o2::header::DataOrigin o2::raw::RawFileWriter::getOrigin ( ) const
inline

Definition at line 196 of file RawFileWriter.h.

◆ getOutputFileForLink()

OutputFile & o2::raw::RawFileWriter::getOutputFileForLink ( const LinkData &  lnk)
inline

Definition at line 253 of file RawFileWriter.h.

◆ getOutputFileName()

std::string o2::raw::RawFileWriter::getOutputFileName ( int  i) const
inline

Definition at line 241 of file RawFileWriter.h.

◆ getSuperPageSize()

int o2::raw::RawFileWriter::getSuperPageSize ( ) const
inline

Definition at line 255 of file RawFileWriter.h.

◆ getUsedRDHDataFormat()

unsigned char o2::raw::RawFileWriter::getUsedRDHDataFormat ( ) const
inline

Definition at line 359 of file RawFileWriter.h.

◆ getUsedRDHVersion()

int o2::raw::RawFileWriter::getUsedRDHVersion ( ) const
inline

Definition at line 352 of file RawFileWriter.h.

◆ getVerbosity()

int o2::raw::RawFileWriter::getVerbosity ( ) const
inline

Definition at line 238 of file RawFileWriter.h.

◆ isCarryOverToLastPageApplied()

bool o2::raw::RawFileWriter::isCarryOverToLastPageApplied ( ) const
inline

Definition at line 393 of file RawFileWriter.h.

◆ isContinuousReadout()

bool o2::raw::RawFileWriter::isContinuousReadout ( ) const
inline

Definition at line 232 of file RawFileWriter.h.

◆ isCRUDetector()

bool o2::raw::RawFileWriter::isCRUDetector ( ) const
inline

Definition at line 391 of file RawFileWriter.h.

◆ isLinkRegistered()

bool o2::raw::RawFileWriter::isLinkRegistered ( LinkSubSpec_t  ss) const
inline

Definition at line 235 of file RawFileWriter.h.

◆ isRDHStopUsed()

bool o2::raw::RawFileWriter::isRDHStopUsed ( ) const
inline

Definition at line 392 of file RawFileWriter.h.

◆ isReadOutModeSet()

bool o2::raw::RawFileWriter::isReadOutModeSet ( ) const
inline

Definition at line 234 of file RawFileWriter.h.

◆ isRORCDetector()

bool o2::raw::RawFileWriter::isRORCDetector ( ) const
inline

Definition at line 390 of file RawFileWriter.h.

◆ isTriggeredReadout()

bool o2::raw::RawFileWriter::isTriggeredReadout ( ) const
inline

Definition at line 233 of file RawFileWriter.h.

◆ newRDHMethod()

void o2::raw::RawFileWriter::newRDHMethod ( const RDHAny *  rdh,
bool  prevEmpty,
std::vector< char > &  toAdd 
) const
inline

Definition at line 348 of file RawFileWriter.h.

◆ registerLink() [1/2]

template<typename H >
LinkData & o2::raw::RawFileWriter::registerLink ( const H &  rdh,
std::string_view  outFileName 
)
inline

Definition at line 183 of file RawFileWriter.h.

◆ registerLink() [2/2]

RawFileWriter::LinkData & RawFileWriter::registerLink ( uint16_t  fee,
uint16_t  cru,
uint8_t  link,
uint8_t  endpoint,
std::string_view  outFileName 
)

Definition at line 136 of file RawFileWriter.cxx.

◆ setAddSeparateHBFStopPage()

void o2::raw::RawFileWriter::setAddSeparateHBFStopPage ( bool  v)
inline

Definition at line 371 of file RawFileWriter.h.

◆ setAlignmentPaddingFiller()

void o2::raw::RawFileWriter::setAlignmentPaddingFiller ( unsigned char  v)
inline

Definition at line 365 of file RawFileWriter.h.

◆ setAlignmentSize()

void o2::raw::RawFileWriter::setAlignmentSize ( unsigned char  v)
inline

Definition at line 364 of file RawFileWriter.h.

◆ setApplyCarryOverToLastPage()

void o2::raw::RawFileWriter::setApplyCarryOverToLastPage ( bool  v)
inline

Definition at line 388 of file RawFileWriter.h.

◆ setCarryOverCallBack()

template<class T >
void o2::raw::RawFileWriter::setCarryOverCallBack ( const T *  t)
inline

Definition at line 264 of file RawFileWriter.h.

◆ setContinuousReadout() [1/2]

void o2::raw::RawFileWriter::setContinuousReadout ( )
inline

Definition at line 217 of file RawFileWriter.h.

◆ setContinuousReadout() [2/2]

void o2::raw::RawFileWriter::setContinuousReadout ( bool  v)
inline

Definition at line 223 of file RawFileWriter.h.

◆ setDontFillEmptyHBF()

void o2::raw::RawFileWriter::setDontFillEmptyHBF ( bool  v)
inline

Definition at line 368 of file RawFileWriter.h.

◆ setEmptyPageCallBack()

template<class T >
void o2::raw::RawFileWriter::setEmptyPageCallBack ( const T *  t)
inline

Definition at line 273 of file RawFileWriter.h.

◆ setNewRDHCallBack()

template<class T >
void o2::raw::RawFileWriter::setNewRDHCallBack ( const T *  t)
inline

Definition at line 281 of file RawFileWriter.h.

◆ setOrigin()

void o2::raw::RawFileWriter::setOrigin ( o2::header::DataOrigin  origin)
inline

Definition at line 191 of file RawFileWriter.h.

◆ setRORCDetector()

void o2::raw::RawFileWriter::setRORCDetector ( )
inline

Definition at line 373 of file RawFileWriter.h.

◆ setSuperPageSize()

void RawFileWriter::setSuperPageSize ( int  nbytes)

Definition at line 215 of file RawFileWriter.cxx.

◆ setTriggeredReadout()

void o2::raw::RawFileWriter::setTriggeredReadout ( )
inline

Definition at line 218 of file RawFileWriter.h.

◆ setUseRDHStop()

void o2::raw::RawFileWriter::setUseRDHStop ( bool  v = true)
inline

Definition at line 380 of file RawFileWriter.h.

◆ setVerbosity()

void o2::raw::RawFileWriter::setVerbosity ( int  v)
inline

Definition at line 237 of file RawFileWriter.h.

◆ useCaching()

void RawFileWriter::useCaching ( )

Definition at line 268 of file RawFileWriter.cxx.

◆ useRDHDataFormat()

void o2::raw::RawFileWriter::useRDHDataFormat ( unsigned char  v)
inline

Definition at line 363 of file RawFileWriter.h.

◆ useRDHVersion()

void o2::raw::RawFileWriter::useRDHVersion ( int  v)
inline

Definition at line 353 of file RawFileWriter.h.

◆ writeConfFile()

void RawFileWriter::writeConfFile ( std::string_view  origin = "FLP",
std::string_view  description = "RAWDATA",
std::string_view  cfgname = "raw.cfg",
bool  fullPath = true 
) const

Definition at line 246 of file RawFileWriter.cxx.

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