CbmStsParSetModule Class Reference

Parameters container for CbmStsParModule. More...

#include <CbmStsParSetModule.h>

Inheritance diagram for CbmStsParSetModule:

Collaboration diagram for CbmStsParSetModule:

Public Member Functions
	CbmStsParSetModule (const char *name="CbmParSetModule", const char *title="STS parameters", const char *context="Default")
	Constructor.
virtual	~CbmStsParSetModule ()
	Destructor.
virtual void	clear ()
	Reset all parameters.
UInt_t	DeactivateRandomChannels (Double_t fraction)
	Randomly deactivate a fraction of the channels.
virtual Bool_t	getParams (FairParamList *parList)
	Reading parameters from ASCII. Abstract in base class.
Bool_t	LoadParASCII (std::string file_name)
	Reading parameters from ASCII.
const CbmStsParModule &	GetParModule (UInt_t address)
	Get condition parameters of a sensor.
Bool_t	IsSet () const
	Check whether parameter container is set.
virtual void	putParams (FairParamList *parList)
void	SetGlobalPar (const CbmStsParModule &params)
	Set global parameters (for all modules)
void	SetParModule (UInt_t address, const CbmStsParModule &par)
	Set the parameters for a module.
std::string	ToString () const
	Info to string.

Private Member Functions
	ClassDef (CbmStsParSetModule, 1)

Private Attributes
Bool_t	fUseGlobal = kFALSE
	Flag for using global parameters.
CbmStsParModule	fGlobalParams {}
	Global parameters, used for all modules.
std::map< UInt_t, CbmStsParModule >	fParams {}
	Map of parameters. Key is module address.

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 34 of file CbmStsParSetModule.h.

Constructor & Destructor Documentation

CbmStsParSetModule()

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

Constructor.

Parameters

name	Name of parameter set
title	Parameter container factory name
context	No idea

Referenced by ClassDef().

~CbmStsParSetModule()

CbmStsParSetModule::~CbmStsParSetModule ( )

virtual

Destructor.

Definition at line 32 of file CbmStsParSetModule.cxx.

Member Function Documentation

ClassDef()

CbmStsParSetModule::ClassDef ( CbmStsParSetModule , 1  )

private

References CbmStsParSetModule().

clear()

void CbmStsParSetModule::clear ( )

virtual

Reset all parameters.

Definition at line 37 of file CbmStsParSetModule.cxx.

References fParams, and fUseGlobal.

DeactivateRandomChannels()

UInt_t CbmStsParSetModule::DeactivateRandomChannels

(

Double_t

fraction

)

Randomly deactivate a fraction of the channels.

Parameters

fraction

Fraction of channels to deactivate

Returns

Number of deactivated channels

Definition at line 48 of file CbmStsParSetModule.cxx.

References fParams.

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 61 of file CbmStsParSetModule.cxx.

GetParModule()

const CbmStsParModule & CbmStsParSetModule::GetParModule

(

UInt_t

address

)

Get condition parameters of a sensor.

Parameters

Module

address

Returns

Module parameter object

Definition at line 148 of file CbmStsParSetModule.cxx.

References fGlobalParams, fParams, and fUseGlobal.

Referenced by 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 86 of file CbmStsParSetModule.h.

References fParams, and fUseGlobal.

LoadParASCII()

Bool_t CbmStsParSetModule::LoadParASCII

(

std::string

file_name

)

Reading parameters from ASCII.

• Parameters

  file_name

  path to the parameters file

Definition at line 69 of file CbmStsParSetModule.cxx.

References fParams, and SetGlobalPar().

putParams()

void CbmStsParSetModule::putParams ( FairParamList * parList )

virtual

Definition at line 158 of file CbmStsParSetModule.cxx.

SetGlobalPar()

void CbmStsParSetModule::SetGlobalPar ( const CbmStsParModule & params )

inline

Set global parameters (for all modules)

Parameters

conditions

Module parameter object

Definition at line 95 of file CbmStsParSetModule.h.

References fGlobalParams, and fUseGlobal.

Referenced by LoadParASCII().

SetParModule()

void CbmStsParSetModule::SetParModule	(	UInt_t	address,
		const CbmStsParModule &	par )

Set the parameters for a module.

Parameters

address	Module address
par	Module parameter object

Definition at line 163 of file CbmStsParSetModule.cxx.

References fParams.

ToString()

std::string CbmStsParSetModule::ToString

(

)

const

Info to string.

Definition at line 172 of file CbmStsParSetModule.cxx.

References fGlobalParams, fParams, and fUseGlobal.

Member Data Documentation

fGlobalParams

CbmStsParModule CbmStsParSetModule::fGlobalParams {}

private

Global parameters, used for all modules.

Definition at line 117 of file CbmStsParSetModule.h.

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

fParams

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

private

Map of parameters. Key is module address.

Definition at line 120 of file CbmStsParSetModule.h.

Referenced by clear(), DeactivateRandomChannels(), GetParModule(), IsSet(), LoadParASCII(), SetParModule(), and ToString().

fUseGlobal

Bool_t CbmStsParSetModule::fUseGlobal = kFALSE

private

Flag for using global parameters.

Definition at line 114 of file CbmStsParSetModule.h.

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

---

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

• CbmStsParSetModule.h
• CbmStsParSetModule.cxx