o2::emcal::NonlinearityFactory Class Reference

Creator and handler class of nonlinearity parameterizations. More...

#include <NonlinearityHandler.h>

Classes
class	FunctionNotFoundExcpetion
	Handling request of non-exisiting nonlinearity functions. More...
class	NonlinInitError
	Handling errors of initialisation of a certain nonlinearity function. More...

Public Member Functions
NonlinearityHandler &	getNonlinearity (NonlinearityHandler::NonlinType_t nonlintype)
	Get nonlinearity handler for the given nonlinearty type.
NonlinearityHandler &	getNonlinearity (const std::string_view nonlintype)
	Get nonlinearity handler for the given nonlinearty name.

Static Public Member Functions
static NonlinearityFactory &	getInstance ()
	Get instance of the nonlinearity factory.

Detailed Description

Creator and handler class of nonlinearity parameterizations.

Author

Markus Fasel marku.nosp@m.s.fa.nosp@m.sel@c.nosp@m.ern..nosp@m.ch, Oak Ridge National Laboratory

Since

Feb 27, 2023

Factory and manager of nonlinearty handlers. The class acts as singleton class. NonlinearityHandlers can be constructed via the function getNonlinearity either using either the symbolic form or using the name as a string representation. In the second case an exception is thrown in case the request is done for a funciton name which doesn't exist.

Definition at line 186 of file NonlinearityHandler.h.

Member Function Documentation

getInstance()

static NonlinearityFactory & o2::emcal::NonlinearityFactory::getInstance ( )

inlinestatic

Get instance of the nonlinearity factory.

Returns

Factory instance

Definition at line 241 of file NonlinearityHandler.h.

getNonlinearity() [1/2]

NonlinearityHandler & NonlinearityFactory::getNonlinearity

(

const std::string_view

nonlintype

)

Get nonlinearity handler for the given nonlinearty name.

Returns

Nonlineary handler for the given nonlinearity function based on its name

Exceptions

FunctionNotFoundExcpetion	in case the name of the function is unknown
NonlinInitError	in case the object could not be constructed

Internally caching existing nonlinearty handlers. Only constructing handler in case the handler is not yet existing.

Definition at line 319 of file NonlinearityHandler.cxx.

getNonlinearity() [2/2]

NonlinearityHandler & NonlinearityFactory::getNonlinearity

(

NonlinearityHandler::NonlinType_t

nonlintype

)

Get nonlinearity handler for the given nonlinearty type.

Returns

Nonlineary handler for the given nonlinearity function

Exceptions

NonlinInitError

in case the object could not be constructed

Internally caching existing nonlinearty handlers. Only constructing handler in case the handler is not yet existing.

Definition at line 306 of file NonlinearityHandler.cxx.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/base/include/EMCALBase/NonlinearityHandler.h
• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/base/src/NonlinearityHandler.cxx