Objects that can be recorded/read into/from configuration files. More...

#include <RingerIOVarDepObj.h>

Inheritance diagram for Ringer::RingerIOVarDepObj< CRTP >:

Collaboration diagram for Ringer::RingerIOVarDepObj< CRTP >:

Public Member Functions
	RingerIOVarDepObj ()
	Typedef to CRTP type: More...

std::string	name () const
	Retrieve name for this RingerIOVarDepObj. More...

void	write (TDirectory baseDir, const char idxStr="") const
	Write Ringer procedure to configuration directory. More...

bool	isWithinRange (const DepVarStruct &depVar) const
	Check if depVar is within this procedure range. More...

bool	isWithinEtaRange (const float eta) const
	Check if eta is within this procedure range. More...

EtaDependency	etaDep () const
	Returns whether it is et dependent. More...

float	etaMin () const
	Get eta min. More...

float	etaMax () const
	Get eta max. More...

float	etMin () const
	Get et min. More...

float	etMax () const
	Get et max. More...

void	setEtaDep (const float etaMin, const float etaMax)
	Set this procedure to be eta dependent: More...

bool	isWithinEtRange (const float et) const
	Check if et is within this procedure et range. More...

EtDependency	etDep () const
	Returns whether it is et dependent. More...

void	setEtDep (const float etMin, const float etMax)
	Set this procedure to be et dependent. More...

void	setEtaEtDep (const float etaMin, const float etaMax, const float etMin, const float etMax)
	Set this procedure to be et dependent. More...

std::string	type () const
	Return this variable dependency string. More...

void	writeDepInfo (TDirectory *configDir) const
	Write variable dependency to directory. More...

Static Public Member Functions
static CRTP *	read (TDirectory *configDir)
	Read Ringer procedure from configuration dir. More...

static void	read (VariableDependency varDep, TDirectory configDir, unsigned writtenVersion)
	Read variable dependency from directory. More...

Private Attributes
EtaDependency	m_etaDependency {EtaDependency::EtaIndependent}
	Whether there is eta dependency. More...

EtDependency	m_etDependency {EtDependency::EtIndependent}
	Whether there is et dependency. More...

float	m_etaMin {0}
	Eta bounded region where RingerProcedure may be applied. More...

float	m_etaMax {0}

float	m_etMin {0}
	Et bounded region where RingerProcedure may be applied. More...

float	m_etMax {0}

Detailed Description

template<class CRTP>
class Ringer::RingerIOVarDepObj< CRTP >

Objects that can be recorded/read into/from configuration files.

Use CRTP mechanism so that we can force static read method to be implemented.

The CRTP class will automatically inherit from BaseProcedure and VariableDependency, the late using etaDependency and etDependency given values.

It also implements the final version of the IRingerProcedure write pure virtual method, which will call both VariableDependency and the BaseProcedure write methods. It also make sure that the configuration directory written to Root will be named as:

"BaseProcedure::type()[VariableDependency::type()]"

Definition at line 194 of file RingerIOVarDepObj.h.

Constructor & Destructor Documentation

◆ RingerIOVarDepObj()

template<class CRTP >

Ringer::RingerIOVarDepObj< CRTP >::RingerIOVarDepObj ( )

inline

Typedef to CRTP type:

Definition at line 204 of file RingerIOVarDepObj.h.

204 :VariableDependency(){;}

Member Function Documentation

◆ etaDep()

EtaDependency Ringer::VariableDependency::etaDep ( ) const

inherited

Returns whether it is et dependent.

◆ etaMax()

float Ringer::VariableDependency::etaMax ( ) const

inherited

Get eta max.

◆ etaMin()

float Ringer::VariableDependency::etaMin ( ) const

inherited

Get eta min.

◆ etDep()

EtDependency Ringer::VariableDependency::etDep ( ) const

inherited

Returns whether it is et dependent.

◆ etMax()

float Ringer::VariableDependency::etMax ( ) const

inherited

Get et max.

◆ etMin()

float Ringer::VariableDependency::etMin ( ) const

inherited

Get et min.

◆ isWithinEtaRange()

bool Ringer::VariableDependency::isWithinEtaRange ( const float eta ) const

inherited

Check if eta is within this procedure range.

◆ isWithinEtRange()

bool Ringer::VariableDependency::isWithinEtRange ( const float et ) const

inherited

Check if et is within this procedure et range.

◆ isWithinRange()

bool Ringer::VariableDependency::isWithinRange ( const DepVarStruct & depVar ) const

inherited

Check if depVar is within this procedure range.

◆ name()

template<class CRTP >

std::string Ringer::RingerIOVarDepObj< CRTP >::name ( ) const

Retrieve name for this RingerIOVarDepObj.

◆ read() [1/2]

template<class CRTP >

static CRTP* Ringer::RingerIOVarDepObj< CRTP >::read ( TDirectory * configDir )

static

Read Ringer procedure from configuration dir.

◆ read() [2/2]

static void Ringer::VariableDependency::read	(	VariableDependency *	varDep,
		TDirectory *	configDir,
		unsigned	writtenVersion
	)

staticinherited

Read variable dependency from directory.

◆ setEtaDep()

void Ringer::VariableDependency::setEtaDep	(	const float	etaMin,
		const float	etaMax
	)

inherited

Set this procedure to be eta dependent:

◆ setEtaEtDep()

void Ringer::VariableDependency::setEtaEtDep	(	const float	etaMin,
		const float	etaMax,
		const float	etMin,
		const float	etMax
	)

inherited

Set this procedure to be et dependent.

◆ setEtDep()

void Ringer::VariableDependency::setEtDep	(	const float	etMin,
		const float	etMax
	)

inherited

Set this procedure to be et dependent.

◆ type()

std::string Ringer::VariableDependency::type ( ) const

inherited

Return this variable dependency string.

This is not a virtual method.

◆ write()

template<class CRTP >

void Ringer::RingerIOVarDepObj< CRTP >::write	(	TDirectory *	baseDir,
		const char *	idxStr = `""`
	)		const

Write Ringer procedure to configuration directory.

◆ writeDepInfo()

void Ringer::VariableDependency::writeDepInfo ( TDirectory * configDir ) const

inherited

Write variable dependency to directory.

This is not a virtual method.

Member Data Documentation

◆ m_etaDependency

EtaDependency Ringer::VariableDependency::m_etaDependency {EtaDependency::EtaIndependent}

privateinherited

Whether there is eta dependency.

Definition at line 225 of file VariableDependency.h.

◆ m_etaMax

float Ringer::VariableDependency::m_etaMax {0}

privateinherited

Definition at line 230 of file VariableDependency.h.

◆ m_etaMin

float Ringer::VariableDependency::m_etaMin {0}

privateinherited

Eta bounded region where RingerProcedure may be applied.

Definition at line 230 of file VariableDependency.h.

◆ m_etDependency

EtDependency Ringer::VariableDependency::m_etDependency {EtDependency::EtIndependent}

privateinherited

Whether there is et dependency.

Definition at line 227 of file VariableDependency.h.

◆ m_etMax

float Ringer::VariableDependency::m_etMax {0}

privateinherited

Definition at line 233 of file VariableDependency.h.

◆ m_etMin

float Ringer::VariableDependency::m_etMin {0}

privateinherited

Et bounded region where RingerProcedure may be applied.

Definition at line 233 of file VariableDependency.h.

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

RingerIOVarDepObj.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<class CRTP> class Ringer::RingerIOVarDepObj< CRTP >

Constructor & Destructor Documentation

◆ RingerIOVarDepObj()

Member Function Documentation

◆ etaDep()

◆ etaMax()

◆ etaMin()

◆ etDep()

◆ etMax()

◆ etMin()

◆ isWithinEtaRange()

◆ isWithinEtRange()

◆ isWithinRange()

◆ name()

◆ read() [1/2]

◆ read() [2/2]

◆ setEtaDep()

◆ setEtaEtDep()

◆ setEtDep()

◆ type()

◆ write()

◆ writeDepInfo()

Member Data Documentation

◆ m_etaDependency

◆ m_etaMax

◆ m_etaMin

◆ m_etDependency

◆ m_etMax

◆ m_etMin

template<class CRTP>
class Ringer::RingerIOVarDepObj< CRTP >