CbmRoot
CbmStsParSetModule Class Reference

Parameters container for CbmStsParModule. More...

#include <CbmStsParSetModule.h>

Inheritance diagram for CbmStsParSetModule:
[legend]
Collaboration diagram for CbmStsParSetModule:
[legend]

Public Member Functions

 CbmStsParSetModule (const char *name="CbmParSetModule", const char *title="STS parameters", const char *context="Default")
 Constructor. More...
 
 CbmStsParSetModule (const CbmStsParSetModule &)=delete
 Copy constructor (disabled) More...
 
 CbmStsParSetModule (CbmStsParSetModule &&)=delete
 Move constructor (disabled) More...
 
virtual ~CbmStsParSetModule ()
 Destructor. More...
 
virtual void clear ()
 Reset all parameters. More...
 
virtual Bool_t getParams (FairParamList *parList)
 Reading parameters from ASCII. Abstract in base class. More...
 
const CbmStsParModuleGetParModule (UInt_t address)
 Get condition parameters of a sensor. More...
 
Bool_t IsSet () const
 Check whether parameter container is set. More...
 
CbmStsParSetModuleoperator= (const CbmStsParSetModule &)=delete
 Copy assignment operator (disabled) More...
 
CbmStsParSetModuleoperator= (CbmStsParSetModule &&)=delete
 Move assignment operator (disabled) More...
 
virtual void putParams (FairParamList *parList)
 Writing parameters to ASCII. Abstract in base class. More...
 
void SetGlobalPar (const CbmStsParModule &params)
 Set global parameters (for all modules) More...
 
std::string ToString () const
 Info to string. More...
 

Private Member Functions

 ClassDef (CbmStsParSetModule, 1)
 

Private Attributes

Bool_t fUseGlobal = kFALSE
 Flag for using global parameters. More...
 
CbmStsParModule fGlobalParams {}
 Global parameters, used for all modules. More...
 
std::map< UInt_t, CbmStsParModulefParams {}
 Map of parameters. Key is sensor address. More...
 

Detailed Description

Parameters container for CbmStsParModule.

Author
Volker Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e
Date
31.03.2020

A set of parameters for each STS module is administered through FairRuntimeDb.

Definition at line 30 of file CbmStsParSetModule.h.

Constructor & Destructor Documentation

◆ CbmStsParSetModule() [1/3]

CbmStsParSetModule::CbmStsParSetModule ( const char *  name = "CbmParSetModule",
const char *  title = "STS parameters",
const char *  context = "Default" 
)

Constructor.

Parameters
nameName of parameter set
titleParameter container factory name
contextNo idea

◆ CbmStsParSetModule() [2/3]

CbmStsParSetModule::CbmStsParSetModule ( const CbmStsParSetModule )
delete

Copy constructor (disabled)

◆ CbmStsParSetModule() [3/3]

CbmStsParSetModule::CbmStsParSetModule ( CbmStsParSetModule &&  )
delete

Move constructor (disabled)

◆ ~CbmStsParSetModule()

CbmStsParSetModule::~CbmStsParSetModule ( )
virtual

Destructor.

Definition at line 26 of file CbmStsParSetModule.cxx.

Member Function Documentation

◆ ClassDef()

CbmStsParSetModule::ClassDef ( CbmStsParSetModule  ,
 
)
private

◆ clear()

void CbmStsParSetModule::clear ( )
virtual

Reset all parameters.

Definition at line 31 of file CbmStsParSetModule.cxx.

References fParams, and fUseGlobal.

Referenced by CbmStsDigitize::InitParams().

◆ getParams()

Bool_t CbmStsParSetModule::getParams ( FairParamList *  parList)
virtual

Reading parameters from ASCII. Abstract in base class.

An ASCII I/O is not implemented. The method throws an error.

Definition at line 41 of file CbmStsParSetModule.cxx.

◆ GetParModule()

const CbmStsParModule & CbmStsParSetModule::GetParModule ( UInt_t  address)

Get condition parameters of a sensor.

Parameters
Moduleaddress
Returns
Module parameter object

Definition at line 49 of file CbmStsParSetModule.cxx.

References fGlobalParams, fParams, and fUseGlobal.

Referenced by CbmRecoSts::CreateModules(), CbmStsDigitizeQa::Init(), CbmStsDigitize::InitModules(), and CbmStsSetup::SetModuleParameters().

◆ IsSet()

Bool_t CbmStsParSetModule::IsSet ( ) const
inline

Check whether parameter container is set.

Returns
True if container is set

The container is set if either global parameters are defined or the parameter map is filled.

Definition at line 79 of file CbmStsParSetModule.h.

References fParams, and fUseGlobal.

◆ operator=() [1/2]

CbmStsParSetModule& CbmStsParSetModule::operator= ( CbmStsParSetModule &&  )
delete

Move assignment operator (disabled)

◆ operator=() [2/2]

CbmStsParSetModule& CbmStsParSetModule::operator= ( const CbmStsParSetModule )
delete

Copy assignment operator (disabled)

◆ putParams()

void CbmStsParSetModule::putParams ( FairParamList *  parList)
virtual

Writing parameters to ASCII. Abstract in base class.

An ASCII I/O is not implemented. The method throws an error.

Definition at line 58 of file CbmStsParSetModule.cxx.

◆ SetGlobalPar()

void CbmStsParSetModule::SetGlobalPar ( const CbmStsParModule params)
inline

Set global parameters (for all modules)

Parameters
conditionsModule parameter object

Definition at line 100 of file CbmStsParSetModule.h.

References fGlobalParams, and fUseGlobal.

Referenced by CbmStsDigitize::InitParams().

◆ ToString()

std::string CbmStsParSetModule::ToString ( ) const

Info to string.

Definition at line 65 of file CbmStsParSetModule.cxx.

References fGlobalParams, fParams, fUseGlobal, and CbmStsParModule::ToString().

Referenced by CbmRecoSts::Init(), and CbmStsDigitize::InitParams().

Member Data Documentation

◆ fGlobalParams

CbmStsParModule CbmStsParSetModule::fGlobalParams {}
private

Global parameters, used for all modules.

Definition at line 115 of file CbmStsParSetModule.h.

Referenced by GetParModule(), SetGlobalPar(), and ToString().

◆ fParams

std::map<UInt_t, CbmStsParModule> CbmStsParSetModule::fParams {}
private

Map of parameters. Key is sensor address.

Definition at line 118 of file CbmStsParSetModule.h.

Referenced by clear(), GetParModule(), IsSet(), and ToString().

◆ fUseGlobal

Bool_t CbmStsParSetModule::fUseGlobal = kFALSE
private

Flag for using global parameters.

Definition at line 112 of file CbmStsParSetModule.h.

Referenced by clear(), GetParModule(), IsSet(), SetGlobalPar(), and ToString().


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