#include <GRPObject.h>

Public Types
enum	ROMode : int { ABSENT = 0 , PRESENT = 0x1 , CONTINUOUS = PRESENT + (0x1 << 1) , TRIGGERING = PRESENT + (0x1 << 2) }

using	timePoint = uint64_t

Public Member Functions
	GRPObject ()=default

	~GRPObject ()=default

timePoint	getTimeStart () const
	getters/setters for Start and Stop times according to logbook

timePoint	getTimeEnd () const

void	setTimeStart (timePoint t)

void	setTimeEnd (timePoint t)

void	setNHBFPerTF (uint32_t n)

uint32_t	getNHBFPerTF () const

void	setFirstOrbit (uint32_t o)

uint32_t	getFirstOrbit () const

o2::units::AngleRad_t	getCrossingAngle () const
	getters/setters for beams crossing angle (deviation from 0)

void	setCrossingAngle (o2::units::AngleRad_t v)

int	getBeamZ (beamDirection beam) const
	getters/setters for given beam A and Z info, encoded as A<<16+Z

int	getBeamA (beamDirection beam) const

float	getBeamZ2A (beamDirection beam) const

void	setBeamAZ (int a, int z, beamDirection beam)

void	setBeamEnergyPerZ (float v)
	getters/setters for beam energy per charge and per nucleon

float	getBeamEnergyPerZ () const

float	getBeamEnergyPerNucleon (beamDirection beam) const

float	getSqrtS () const
	calculate center of mass energy per nucleon collision

o2::units::Current_t	getL3Current () const
	getters/setters for magnets currents

o2::units::Current_t	getDipoleCurrent () const

bool	getFieldUniformity () const

void	setL3Current (o2::units::Current_t v)

void	setDipoleCurrent (o2::units::Current_t v)

void	setFieldUniformity (bool v)

int8_t	getNominalL3Field ()

const std::string &	getDataPeriod () const
	getter/setter for data taking period name

void	setDataPeriod (const std::string v)

const std::string &	getLHCState () const
	getter/setter for LHC state in the beggining of run

void	setLHCState (const std::string v)

void	setRun (int r)

int	getRun () const

void	setFill (int f)
	getter/setter for fill identifier

int	getFill () const

DetID::mask_t	getDetsReadOut () const
	getter/setter for masks of detectors in the readout

void	setDetsReadOut (DetID::mask_t mask)

DetID::mask_t	getDetsContinuousReadOut () const
	getter/setter for masks of detectors with continuos readout

void	setDetsContinuousReadOut (DetID::mask_t mask)

DetID::mask_t	getDetsTrigger () const
	getter/setter for masks of detectors providing the trigger

void	setDetsTrigger (DetID::mask_t mask)

void	addDetReadOut (DetID id)
	add specific detector to the list of readout detectors

void	remDetReadOut (DetID id)
	remove specific detector from the list of readout detectors

void	addDetContinuousReadOut (DetID id)
	add specific detector to the list of continuously readout detectors

void	remDetContinuousReadOut (DetID id)
	remove specific detector from the list of continuouslt readout detectors

void	addDetTrigger (DetID id)
	add specific detector to the list of triggering detectors

void	remDetTrigger (DetID id)
	remove specific detector from the list of triggering detectors

bool	isDetReadOut (DetID id) const
	test if detector is read out

bool	isDetContinuousReadOut (DetID id) const
	test if detector is read out

bool	isDetTriggers (DetID id) const
	test if detector is triggering

void	setDetROMode (DetID id, ROMode status)
	set detector readout mode status

ROMode	getDetROMode (DetID id) const

DetID::mask_t	getDetsReadOut (DetID::mask_t only, DetID::mask_t skip=0) const

DetID::mask_t	getDetsReadOut (const std::string &only, const std::string &skip="") const
	same with comma-separate list of detector names

bool	isMC () const

void	setIsMC (bool v=true)

void	print () const
	print itself

Static Public Member Functions
static GRPObject *	loadFrom (const std::string &grpFileName="")

Detailed Description

Definition at line 35 of file GRPObject.h.

Member Typedef Documentation

◆ timePoint

using o2::parameters::GRPObject::timePoint = uint64_t

Definition at line 41 of file GRPObject.h.

Member Enumeration Documentation

◆ ROMode

enum o2::parameters::GRPObject::ROMode : int

Enumerator
ABSENT
PRESENT
CONTINUOUS
TRIGGERING

Definition at line 43 of file GRPObject.h.

Constructor & Destructor Documentation

◆ GRPObject()

o2::parameters::GRPObject::GRPObject ( )

default

◆ ~GRPObject()

o2::parameters::GRPObject::~GRPObject ( )

default

Member Function Documentation

◆ addDetContinuousReadOut()

void o2::parameters::GRPObject::addDetContinuousReadOut ( DetID id )

inline

add specific detector to the list of continuously readout detectors

Definition at line 117 of file GRPObject.h.

◆ addDetReadOut()

void o2::parameters::GRPObject::addDetReadOut ( DetID id )

inline

add specific detector to the list of readout detectors

Definition at line 108 of file GRPObject.h.

◆ addDetTrigger()

void o2::parameters::GRPObject::addDetTrigger ( DetID id )

inline

add specific detector to the list of triggering detectors

Definition at line 121 of file GRPObject.h.

◆ getBeamA()

int o2::parameters::GRPObject::getBeamA ( beamDirection beam ) const

inline

Definition at line 68 of file GRPObject.h.

◆ getBeamEnergyPerNucleon()

float o2::parameters::GRPObject::getBeamEnergyPerNucleon ( beamDirection beam ) const

inline

Definition at line 74 of file GRPObject.h.

◆ getBeamEnergyPerZ()

float o2::parameters::GRPObject::getBeamEnergyPerZ ( ) const

inline

Definition at line 73 of file GRPObject.h.

◆ getBeamZ()

int o2::parameters::GRPObject::getBeamZ ( beamDirection beam ) const

inline

getters/setters for given beam A and Z info, encoded as A<<16+Z

Definition at line 67 of file GRPObject.h.

◆ getBeamZ2A()

float o2::parameters::GRPObject::getBeamZ2A ( beamDirection beam ) const

inline

Definition at line 179 of file GRPObject.h.

◆ getCrossingAngle()

o2::units::AngleRad_t o2::parameters::GRPObject::getCrossingAngle ( ) const

inline

getters/setters for beams crossing angle (deviation from 0)

Definition at line 64 of file GRPObject.h.

◆ getDataPeriod()

const std::string & o2::parameters::GRPObject::getDataPeriod ( ) const

inline

getter/setter for data taking period name

Definition at line 87 of file GRPObject.h.

◆ getDetROMode()

GRPObject::ROMode GRPObject::getDetROMode ( DetID id ) const

Definition at line 97 of file GRPObject.cxx.

◆ getDetsContinuousReadOut()

DetID::mask_t o2::parameters::GRPObject::getDetsContinuousReadOut ( ) const

inline

getter/setter for masks of detectors with continuos readout

Definition at line 102 of file GRPObject.h.

◆ getDetsReadOut() [1/3]

DetID::mask_t o2::parameters::GRPObject::getDetsReadOut ( ) const

inline

getter/setter for masks of detectors in the readout

Definition at line 99 of file GRPObject.h.

◆ getDetsReadOut() [2/3]

DetID::mask_t o2::parameters::GRPObject::getDetsReadOut	(	const std::string &	only,
		const std::string &	skip = `""`
	)		const

inline

same with comma-separate list of detector names

Definition at line 138 of file GRPObject.h.

◆ getDetsReadOut() [3/3]

DetID::mask_t o2::parameters::GRPObject::getDetsReadOut	(	DetID::mask_t	only,
		DetID::mask_t	skip = `0`
	)		const

inline

extra selections mask of readout detectors with addition selections. "only" overrides "skip"

Definition at line 136 of file GRPObject.h.

◆ getDetsTrigger()

DetID::mask_t o2::parameters::GRPObject::getDetsTrigger ( ) const

inline

getter/setter for masks of detectors providing the trigger

Definition at line 105 of file GRPObject.h.

◆ getDipoleCurrent()

o2::units::Current_t o2::parameters::GRPObject::getDipoleCurrent ( ) const

inline

Definition at line 80 of file GRPObject.h.

◆ getFieldUniformity()

bool o2::parameters::GRPObject::getFieldUniformity ( ) const

inline

Definition at line 81 of file GRPObject.h.

◆ getFill()

int o2::parameters::GRPObject::getFill ( ) const

inline

Definition at line 97 of file GRPObject.h.

◆ getFirstOrbit()

uint32_t o2::parameters::GRPObject::getFirstOrbit ( ) const

inline

Definition at line 61 of file GRPObject.h.

◆ getL3Current()

o2::units::Current_t o2::parameters::GRPObject::getL3Current ( ) const

inline

getters/setters for magnets currents

Definition at line 79 of file GRPObject.h.

◆ getLHCState()

const std::string & o2::parameters::GRPObject::getLHCState ( ) const

inline

getter/setter for LHC state in the beggining of run

Definition at line 90 of file GRPObject.h.

◆ getNHBFPerTF()

uint32_t o2::parameters::GRPObject::getNHBFPerTF ( ) const

inline

Definition at line 58 of file GRPObject.h.

◆ getNominalL3Field()

int8_t o2::parameters::GRPObject::getNominalL3Field ( )

inline

Definition at line 187 of file GRPObject.h.

◆ getRun()

int o2::parameters::GRPObject::getRun ( ) const

inline

Definition at line 94 of file GRPObject.h.

◆ getSqrtS()

float GRPObject::getSqrtS ( ) const

calculate center of mass energy per nucleon collision

Definition at line 29 of file GRPObject.cxx.

◆ getTimeEnd()

timePoint o2::parameters::GRPObject::getTimeEnd ( ) const

inline

Definition at line 53 of file GRPObject.h.

◆ getTimeStart()

timePoint o2::parameters::GRPObject::getTimeStart ( ) const

inline

getters/setters for Start and Stop times according to logbook

Definition at line 52 of file GRPObject.h.

◆ isDetContinuousReadOut()

bool o2::parameters::GRPObject::isDetContinuousReadOut ( DetID id ) const

inline

test if detector is read out

Definition at line 127 of file GRPObject.h.

◆ isDetReadOut()

bool o2::parameters::GRPObject::isDetReadOut ( DetID id ) const

inline

test if detector is read out

Definition at line 125 of file GRPObject.h.

◆ isDetTriggers()

bool o2::parameters::GRPObject::isDetTriggers ( DetID id ) const

inline

test if detector is triggering

Definition at line 129 of file GRPObject.h.

◆ isMC()

bool o2::parameters::GRPObject::isMC ( ) const

inline

Definition at line 140 of file GRPObject.h.

◆ loadFrom()

GRPObject * GRPObject::loadFrom ( const std::string & grpFileName = "" )

static

Definition at line 114 of file GRPObject.cxx.

◆ print()

void GRPObject::print ( ) const

print itself

Definition at line 46 of file GRPObject.cxx.

◆ remDetContinuousReadOut()

void o2::parameters::GRPObject::remDetContinuousReadOut ( DetID id )

inline

remove specific detector from the list of continuouslt readout detectors

Definition at line 119 of file GRPObject.h.

◆ remDetReadOut()

void o2::parameters::GRPObject::remDetReadOut ( DetID id )

inline

remove specific detector from the list of readout detectors

Definition at line 110 of file GRPObject.h.

◆ remDetTrigger()

void o2::parameters::GRPObject::remDetTrigger ( DetID id )

inline

remove specific detector from the list of triggering detectors

Definition at line 123 of file GRPObject.h.

◆ setBeamAZ()

void o2::parameters::GRPObject::setBeamAZ	(	int	a,
		int	z,
		beamDirection	beam
	)

inline

Definition at line 70 of file GRPObject.h.

◆ setBeamEnergyPerZ()

void o2::parameters::GRPObject::setBeamEnergyPerZ ( float v )

inline

getters/setters for beam energy per charge and per nucleon

Definition at line 72 of file GRPObject.h.

◆ setCrossingAngle()

void o2::parameters::GRPObject::setCrossingAngle ( o2::units::AngleRad_t v )

inline

Definition at line 65 of file GRPObject.h.

◆ setDataPeriod()

void o2::parameters::GRPObject::setDataPeriod ( const std::string v )

inline

Definition at line 88 of file GRPObject.h.

◆ setDetROMode()

void GRPObject::setDetROMode	(	DetID	id,
		ROMode	status
	)

set detector readout mode status

Definition at line 76 of file GRPObject.cxx.

◆ setDetsContinuousReadOut()

void o2::parameters::GRPObject::setDetsContinuousReadOut ( DetID::mask_t mask )

inline

Definition at line 103 of file GRPObject.h.

◆ setDetsReadOut()

void o2::parameters::GRPObject::setDetsReadOut ( DetID::mask_t mask )

inline

Definition at line 100 of file GRPObject.h.

◆ setDetsTrigger()

void o2::parameters::GRPObject::setDetsTrigger ( DetID::mask_t mask )

inline

Definition at line 106 of file GRPObject.h.

◆ setDipoleCurrent()

void o2::parameters::GRPObject::setDipoleCurrent ( o2::units::Current_t v )

inline

Definition at line 83 of file GRPObject.h.

◆ setFieldUniformity()

void o2::parameters::GRPObject::setFieldUniformity ( bool v )

inline

Definition at line 84 of file GRPObject.h.

◆ setFill()

void o2::parameters::GRPObject::setFill ( int f )

inline

getter/setter for fill identifier

Definition at line 96 of file GRPObject.h.

◆ setFirstOrbit()

void o2::parameters::GRPObject::setFirstOrbit ( uint32_t o )

inline

Definition at line 60 of file GRPObject.h.

◆ setIsMC()

void o2::parameters::GRPObject::setIsMC ( bool v = true )

inline

Definition at line 141 of file GRPObject.h.

◆ setL3Current()

void o2::parameters::GRPObject::setL3Current ( o2::units::Current_t v )

inline

Definition at line 82 of file GRPObject.h.

◆ setLHCState()

void o2::parameters::GRPObject::setLHCState ( const std::string v )

inline

Definition at line 91 of file GRPObject.h.

◆ setNHBFPerTF()

void o2::parameters::GRPObject::setNHBFPerTF ( uint32_t n )

inline

Definition at line 57 of file GRPObject.h.

◆ setRun()

void o2::parameters::GRPObject::setRun ( int r )

inline

Definition at line 93 of file GRPObject.h.

◆ setTimeEnd()

void o2::parameters::GRPObject::setTimeEnd ( timePoint t )

inline

Definition at line 55 of file GRPObject.h.

◆ setTimeStart()

void o2::parameters::GRPObject::setTimeStart ( timePoint t )

inline

Definition at line 54 of file GRPObject.h.

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

/home/runner/work/AliceO2/AliceO2/DataFormats/Parameters/include/DataFormatsParameters/GRPObject.h
/home/runner/work/AliceO2/AliceO2/DataFormats/Parameters/src/GRPObject.cxx

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ timePoint

Member Enumeration Documentation

◆ ROMode

Constructor & Destructor Documentation

◆ GRPObject()

◆ ~GRPObject()

Member Function Documentation

◆ addDetContinuousReadOut()

◆ addDetReadOut()

◆ addDetTrigger()

◆ getBeamA()

◆ getBeamEnergyPerNucleon()

◆ getBeamEnergyPerZ()

◆ getBeamZ()

◆ getBeamZ2A()

◆ getCrossingAngle()

◆ getDataPeriod()

◆ getDetROMode()

◆ getDetsContinuousReadOut()

◆ getDetsReadOut() [1/3]

◆ getDetsReadOut() [2/3]

◆ getDetsReadOut() [3/3]

◆ getDetsTrigger()

◆ getDipoleCurrent()

◆ getFieldUniformity()

◆ getFill()

◆ getFirstOrbit()

◆ getL3Current()

◆ getLHCState()

◆ getNHBFPerTF()

◆ getNominalL3Field()

◆ getRun()

◆ getSqrtS()

◆ getTimeEnd()

◆ getTimeStart()

◆ isDetContinuousReadOut()

◆ isDetReadOut()

◆ isDetTriggers()

◆ isMC()

◆ loadFrom()

◆ print()

◆ remDetContinuousReadOut()

◆ remDetReadOut()

◆ remDetTrigger()

◆ setBeamAZ()

◆ setBeamEnergyPerZ()

◆ setCrossingAngle()

◆ setDataPeriod()

◆ setDetROMode()

◆ setDetsContinuousReadOut()

◆ setDetsReadOut()

◆ setDetsTrigger()

◆ setDipoleCurrent()

◆ setFieldUniformity()

◆ setFill()

◆ setFirstOrbit()

◆ setIsMC()

◆ setL3Current()

◆ setLHCState()

◆ setNHBFPerTF()

◆ setRun()

◆ setTimeEnd()

◆ setTimeStart()