#include <HBFUtils.h>

Inherits o2::conf::ConfigurableParamHelper< HBFUtils >.

Public Types
using	IR = o2::InteractionRecord

Public Types inherited from o2::conf::ConfigurableParam
enum	EParamProvenance { kCODE , kCCDB , kRT }

enum class	EParamUpdateStatus { Changed , Unchanged , Failed }

Public Member Functions
IR	getFirstIR () const

int	getNOrbitsPerTF () const
	get IR corresponding to start of the HBF

IR	getIRHBF (uint32_t hbf) const
	get IR corresponding to start of the TF

IR	getIRTF (uint32_t tf) const
	get HBF ID corresponding to this IR

uint32_t	getHBF (const IR &rec) const
	get TF ID corresponding to this IR

uint32_t	getTF (const IR &rec) const
	get TF and HB (within TF) for this IR

std::pair< int, int >	getTFandHBinTF (const IR &rec) const
	get 1st IR of the TF corresponding to provided interaction record

IR	getFirstIRofTF (const IR &rec) const
	get 1st IR of TF corresponding to the 1st sampled orbit (in MC)

IR	getFirstSampledTFIR () const
	get TF and HB (abs) for this IR

std::pair< int, int >	getTFandHB (const IR &rec) const
	calculate TF timestamp in ms

uint64_t	getTFTimeStamp (const IR &rec) const
	create RDH for given IR

template<typename H >
H	createRDH (const IR &rec, bool setHBTF=true) const
	update RDH for with given IR info

template<typename H >
void	updateRDH (H &rdh, const IR &rec, bool setHBTF=true) const

int	fillHBIRvector (std::vector< IR > &dst, const IR &fromIR, const IR &toIR) const

void	print () const

void	checkConsistency () const

	O2ParamDef (HBFUtils, "HBFUtils")

Public Member Functions inherited from o2::conf::ConfigurableParamHelper< HBFUtils >
std::string	getName () const final

EParamProvenance	getMemberProvenance (const std::string &key) const final

void	printKeyValues (bool showProv=true, bool useLogger=false, bool withPadding=true, bool showHash=true) const final

size_t	getHash () const final

void	output (std::ostream &out) const final

std::vector< ParamDataMember > *	getDataMembers () const

void	putKeyValues (boost::property_tree::ptree *tree) final

void	initFrom (TFile *file) final

void	syncCCDBandRegistry (void *externalobj) final

void	serializeTo (TFile *file) const final

	ConfigurableParam ()

Public Attributes
int	nHBFPerTF = 128
	number of orbits per BC

bool	obligatorySOR = false
	in mc->raw always start from run 1st TF to set the SOR

uint32_t	orbitFirst = 0
	orbit of 1st TF of the run

uint32_t	runNumber = 0
	run number

uint32_t	orbitFirstSampled = 0
	1st orbit sampled in the MC

uint32_t	maxNOrbits = 0xffffffff
	max number of orbits to accept, used in digit->raw conversion

uint64_t	startTime = 0
	absolute time in ms corresponding to the start of the MC run

Additional Inherited Members
Static Public Member Functions inherited from o2::conf::ConfigurableParamHelper< HBFUtils >
static const HBFUtils &	Instance ()

Static Public Member Functions inherited from o2::conf::ConfigurableParam
static std::string	toString (EParamProvenance p)

static EParamProvenance	getProvenance (const std::string &key)

static void	printAllRegisteredParamNames ()

static void	printAllKeyValuePairs (bool useLogger=false)

static const std::string &	getOutputDir ()

static void	setOutputDir (const std::string &d)

static bool	configFileExists (std::string const &filepath)

static void	writeJSON (std::string const &filename, std::string const &keyOnly="")

static void	writeINI (std::string const &filename, std::string const &keyOnly="")

static void	write (std::string const &filename, std::string const &keyOnly="")

static std::string	asJSON (std::string const &keyOnly="")

template<typename T >
static T	getValueAs (std::string key)

template<typename T >
static void	setValue (std::string const &mainkey, std::string const &subkey, T x)

static void	setProvenance (std::string const &mainkey, std::string const &subkey, EParamProvenance p)

static void	setValue (std::string const &key, std::string const &valuestring)

static void	setEnumValue (const std::string &, const std::string &)

static void	setArrayValue (const std::string &, const std::string &)

static void	setContainerValue (const std::string &, const std::string &)

static bool	isRegisteredContainerType (const std::string &typeName)

static void	registerContainerType (const std::string &key, const std::string &typeName)

static std::string	getRegisteredContainerType (const std::string &key)

static bool	assignRegisteredContainer (const std::string &typeName, void target, const void source)

static bool	areRegisteredContainersEqual (const std::string &typeName, const void lhs, const void rhs)

static std::string	registeredContainerAsString (const std::string &typeName, const void *source)

static void	setValues (std::vector< std::pair< std::string, std::string > > const &keyValues)

static void	initialize ()

static void	toCCDB (std::string filename)

static void	fromCCDB (std::string filename)

static void	updateFromString (std::string const &)

static void	updateFromFile (std::string const &, std::string const &paramsList="", bool unchangedOnly=false)

static void	updateFromJSONString (std::string const &, std::string const &paramsList="", bool unchangedOnly=false)

Protected Member Functions inherited from o2::conf::ConfigurableParam
	ConfigurableParam ()

virtual	~ConfigurableParam ()=default

void	setRegisterMode (bool b)

bool	isInitialized () const

Static Protected Member Functions inherited from o2::conf::ConfigurableParam
static void	initPropertyTree ()

static EParamUpdateStatus	updateThroughStorageMap (std::string, std::string, std::type_info const &, void *)

static EParamUpdateStatus	updateThroughStorageMapWithConversion (std::string const &, std::string const &)

Static Protected Attributes inherited from o2::conf::ConfigurableParam
static std::map< std::string, std::pair< std::type_info const &, void * > > *	sKeyToStorageMap = nullptr

static std::map< std::string, ConfigurableParam::EParamProvenance > *	sValueProvenanceMap = nullptr

static EnumRegistry *	sEnumRegistry = nullptr

static std::string	sOutputDir = ""

Detailed Description

Definition at line 44 of file HBFUtils.h.

Member Typedef Documentation

◆ IR

using o2::raw::HBFUtils::IR = o2::InteractionRecord

Definition at line 45 of file HBFUtils.h.

Member Function Documentation

◆ checkConsistency()

void HBFUtils::checkConsistency ( ) const

Definition at line 53 of file HBFUtils.cxx.

◆ createRDH()

template<typename H >

H o2::raw::HBFUtils::createRDH	(	const IR &	rec,
		bool	setHBTF = `true`
	)		const

inline

update RDH for with given IR info

Definition at line 173 of file HBFUtils.h.

◆ fillHBIRvector()

int HBFUtils::fillHBIRvector	(	std::vector< IR > &	dst,
		const IR &	fromIR,
		const IR &	toIR
	)		const

Definition at line 37 of file HBFUtils.cxx.

◆ getFirstIR()

IR o2::raw::HBFUtils::getFirstIR ( ) const

inline

Definition at line 47 of file HBFUtils.h.

◆ getFirstIRofTF()

IR o2::raw::HBFUtils::getFirstIRofTF ( const IR & rec ) const

inline

get 1st IR of TF corresponding to the 1st sampled orbit (in MC)

Definition at line 71 of file HBFUtils.h.

◆ getFirstSampledTFIR()

IR o2::raw::HBFUtils::getFirstSampledTFIR ( ) const

inline

get TF and HB (abs) for this IR

Definition at line 74 of file HBFUtils.h.

◆ getHBF()

uint32_t HBFUtils::getHBF ( const IR & rec ) const

get TF ID corresponding to this IR

< get HBF ID corresponding to this IR

Definition at line 24 of file HBFUtils.cxx.

◆ getIRHBF()

IR o2::raw::HBFUtils::getIRHBF ( uint32_t hbf ) const

inline

get IR corresponding to start of the TF

Definition at line 52 of file HBFUtils.h.

◆ getIRTF()

IR o2::raw::HBFUtils::getIRTF ( uint32_t tf ) const

inline

get HBF ID corresponding to this IR

Definition at line 55 of file HBFUtils.h.

◆ getNOrbitsPerTF()

int o2::raw::HBFUtils::getNOrbitsPerTF ( ) const

inline

get IR corresponding to start of the HBF

Definition at line 49 of file HBFUtils.h.

◆ getTF()

uint32_t o2::raw::HBFUtils::getTF ( const IR & rec ) const

inline

get TF and HB (within TF) for this IR

Definition at line 61 of file HBFUtils.h.

◆ getTFandHB()

std::pair< int, int > o2::raw::HBFUtils::getTFandHB ( const IR & rec ) const

inline

calculate TF timestamp in ms

Definition at line 77 of file HBFUtils.h.

◆ getTFandHBinTF()

std::pair< int, int > o2::raw::HBFUtils::getTFandHBinTF ( const IR & rec ) const

inline

get 1st IR of the TF corresponding to provided interaction record

Definition at line 64 of file HBFUtils.h.

◆ getTFTimeStamp()

uint64_t o2::raw::HBFUtils::getTFTimeStamp ( const IR & rec ) const

inline

create RDH for given IR

Definition at line 84 of file HBFUtils.h.

◆ O2ParamDef()

o2::raw::HBFUtils::O2ParamDef	(	HBFUtils	,
		"HBFUtils"
	)

◆ print()

void o2::raw::HBFUtils::print ( ) const

inline

Definition at line 134 of file HBFUtils.h.

◆ updateRDH()

template<typename H >

void o2::raw::HBFUtils::updateRDH	(	H &	rdh,
		const IR &	rec,
		bool	setHBTF = `true`
	)		const

Definition at line 151 of file HBFUtils.h.

Member Data Documentation

◆ maxNOrbits

uint32_t o2::raw::HBFUtils::maxNOrbits = 0xffffffff

max number of orbits to accept, used in digit->raw conversion

Definition at line 143 of file HBFUtils.h.

◆ nHBFPerTF

int o2::raw::HBFUtils::nHBFPerTF = 128

number of orbits per BC

Definition at line 138 of file HBFUtils.h.

◆ obligatorySOR

bool o2::raw::HBFUtils::obligatorySOR = false

in mc->raw always start from run 1st TF to set the SOR

Definition at line 139 of file HBFUtils.h.

◆ orbitFirst

uint32_t o2::raw::HBFUtils::orbitFirst = 0

orbit of 1st TF of the run

Definition at line 140 of file HBFUtils.h.

◆ orbitFirstSampled

uint32_t o2::raw::HBFUtils::orbitFirstSampled = 0

1st orbit sampled in the MC

Definition at line 142 of file HBFUtils.h.

◆ runNumber

uint32_t o2::raw::HBFUtils::runNumber = 0

run number

Definition at line 141 of file HBFUtils.h.

◆ startTime

uint64_t o2::raw::HBFUtils::startTime = 0

absolute time in ms corresponding to the start of the MC run

Definition at line 144 of file HBFUtils.h.

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

/home/runner/work/AliceO2/AliceO2/Detectors/Raw/include/DetectorsRaw/HBFUtils.h
/home/runner/work/AliceO2/AliceO2/Detectors/Raw/src/HBFUtils.cxx

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IR

Member Function Documentation

◆ checkConsistency()

◆ createRDH()

◆ fillHBIRvector()

◆ getFirstIR()

◆ getFirstIRofTF()

◆ getFirstSampledTFIR()

◆ getHBF()

◆ getIRHBF()

◆ getIRTF()

◆ getNOrbitsPerTF()

◆ getTF()

◆ getTFandHB()

◆ getTFandHBinTF()

◆ getTFTimeStamp()

◆ O2ParamDef()

◆ print()

◆ updateRDH()

Member Data Documentation

◆ maxNOrbits

◆ nHBFPerTF

◆ obligatorySOR

◆ orbitFirst

◆ orbitFirstSampled

◆ runNumber

◆ startTime