Project
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
o2::tof::Parameters< nPar > Class Template Reference

#include <ParameterContainers.h>

Public Member Functions

 Parameters (std::array< std::string, nPar > parNames, std::string name)
 Default constructor.
 
 ~Parameters ()=default
 Default destructor.
 
void setParameter (const unsigned int iparam, const paramvar_t value)
 
void setParameters (const paramvar_t *params)
 
void setParameters (const std::array< paramvar_t, nPar > params)
 
void setParameters (const Parameters< nPar > params)
 
void setParameters (const Parameters< nPar > *params)
 
void print () const
 Printer of the parameter values.
 
void addToMetadata (std::map< std::string, std::string > &metadata) const
 Adds the parameters to the metadata.
 
void loadParamFromFile (const TString FileName, const TString ParamName)
 
const paramvar_t * getParameters () const
 
const paramvar_t getParameter (int i) const
 
const std::string getParameterName (int i) const
 
const std::string getName () const
 
paramvar_t operator[] (const unsigned int i) const
 

Static Public Member Functions

static int size ()
 

Detailed Description

template<int nPar>
class o2::tof::Parameters< nPar >

Definition at line 33 of file ParameterContainers.h.

Constructor & Destructor Documentation

◆ Parameters()

template<int nPar>
o2::tof::Parameters< nPar >::Parameters ( std::array< std::string, nPar >  parNames,
std::string  name 
)
inline

Default constructor.

Definition at line 37 of file ParameterContainers.h.

◆ ~Parameters()

template<int nPar>
o2::tof::Parameters< nPar >::~Parameters ( )
default

Default destructor.

Member Function Documentation

◆ addToMetadata()

template<int nPar>
void o2::tof::Parameters< nPar >::addToMetadata ( std::map< std::string, std::string > &  metadata) const
inline

Adds the parameters to the metadata.

Definition at line 78 of file ParameterContainers.h.

◆ getName()

template<int nPar>
const std::string o2::tof::Parameters< nPar >::getName ( ) const
inline

Getter for the parameters

Returns
returns an array of parameters

Definition at line 124 of file ParameterContainers.h.

◆ getParameter()

template<int nPar>
const paramvar_t o2::tof::Parameters< nPar >::getParameter ( int  i) const
inline

Getter for the parameters

Returns
returns an array of parameters

Definition at line 116 of file ParameterContainers.h.

◆ getParameterName()

template<int nPar>
const std::string o2::tof::Parameters< nPar >::getParameterName ( int  i) const
inline

Getter for the parameters

Returns
returns an array of parameters

Definition at line 120 of file ParameterContainers.h.

◆ getParameters()

template<int nPar>
const paramvar_t * o2::tof::Parameters< nPar >::getParameters ( ) const
inline

Getter for the parameters

Returns
returns an array of parameters

Definition at line 112 of file ParameterContainers.h.

◆ loadParamFromFile()

template<int nPar>
void o2::tof::Parameters< nPar >::loadParamFromFile ( const TString  FileName,
const TString  ParamName 
)
inline

Loader from file

Parameters
FileNamename of the input file
ParamNamename of the input object

Definition at line 88 of file ParameterContainers.h.

◆ operator[]()

template<int nPar>
paramvar_t o2::tof::Parameters< nPar >::operator[] ( const unsigned int  i) const
inline

Getter of the parameter at position i

Parameters
iindex of the parameter to get
Returns
returns the parameter value at position i

Definition at line 133 of file ParameterContainers.h.

◆ print()

template<int nPar>
void o2::tof::Parameters< nPar >::print ( ) const
inline

Printer of the parameter values.

Definition at line 69 of file ParameterContainers.h.

◆ setParameter()

template<int nPar>
void o2::tof::Parameters< nPar >::setParameter ( const unsigned int  iparam,
const paramvar_t  value 
)
inline

Setter for the parameter at position iparam

Parameters
iparamindex in the array of the parameters
valuevalue of the parameter at position iparam

Definition at line 45 of file ParameterContainers.h.

◆ setParameters() [1/4]

template<int nPar>
void o2::tof::Parameters< nPar >::setParameters ( const Parameters< nPar > *  params)
inline

Setter for the parameter, using a parameter pointer

Parameters
paramspointer to parameter object with parameters

Definition at line 66 of file ParameterContainers.h.

◆ setParameters() [2/4]

template<int nPar>
void o2::tof::Parameters< nPar >::setParameters ( const Parameters< nPar >  params)
inline

Setter for the parameter, using a parameter object

Parameters
paramsparameter object with parameters

Definition at line 62 of file ParameterContainers.h.

◆ setParameters() [3/4]

template<int nPar>
void o2::tof::Parameters< nPar >::setParameters ( const paramvar_t *  params)
inline

Setter for the parameter, using an array

Parameters
paramarray with parameters

Definition at line 49 of file ParameterContainers.h.

◆ setParameters() [4/4]

template<int nPar>
void o2::tof::Parameters< nPar >::setParameters ( const std::array< paramvar_t, nPar >  params)
inline

Setter for the parameter, using a vector

Parameters
paramsvector with parameters

Definition at line 53 of file ParameterContainers.h.

◆ size()

template<int nPar>
static int o2::tof::Parameters< nPar >::size ( )
inlinestatic

Getter for the size of the parameter

Returns
returns the size of the parameter array

Definition at line 128 of file ParameterContainers.h.

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