Handles an shared pointer of CA parameters in double precision with original magnetic field. More...

#include <CbmCaParametersHandler.h>

Inheritance diagram for cbm::ca::ParametersHandler:

Collaboration diagram for cbm::ca::ParametersHandler:

Public Types
using	ParametersPtr_t = std::shared_ptr<const cbm::algo::ca::Parameters<double>>

Public Member Functions
	ParametersHandler (const ParametersHandler &)=delete

	ParametersHandler (ParametersHandler &&)=delete

ParametersHandler &	operator= (const ParametersHandler &)=delete

ParametersHandler &	operator= (ParametersHandler &&)=delete

ParametersPtr_t	Get () const
	Accessor to the parameters shared pointer.

void	DisableStation (algo::ca::EDetectorID detId, int locId)
	Disables tracking station.

void	SetMainConfig (const std::string &mainConfig)
	Sets path to the main config.

void	SetUserConfig (const std::string &userConfig)
	Sets path to the user config.

void	SetFieldMode (algo::kf::EFieldMode fldMode)
	Sets the magnetic field mode.

void	SetIgnoreHitPresence (bool ignoreHitPresence)
	Sets ignore hit presence.

void	StoreParameters (const std::string &filename)
	Stores parameters in a file.

Static Public Member Functions
static ParametersHandler &	Instance ()
	Instance.

Protected Member Functions
InitStatus	Init () override
	Initializes the instance.

InitStatus	ReInit () override
	Re-initializes the instance.

Private Member Functions
	ParametersHandler ()=default
	Default constructor.

	~ParametersHandler ()=default
	Destructor.

	ClassDefOverride (ParametersHandler, 0)

Private Attributes
std::string	fsMainConfig {}
	Main config.

std::string	fsUserConfig {}
	User config.

std::string	fsOutFilename {}
	Parameters output filename.

std::vector< std::pair< algo::ca::EDetectorID, int > >	fvInactiveIds
	Inactive stations.

ParametersPtr_t	fpParameters {nullptr}
	ca::Parameters instance (double precision)

algo::kf::EFieldMode	fFldMode {algo::kf::EFieldMode::Original}
	magnetic field mode

bool	fbIgnoreHitPresence {false}
	ignores hit presence, when checks active detectors

Detailed Description

Handles an shared pointer of CA parameters in double precision with original magnetic field.

Note: This class requires an initialization, which can be done only within the FairRun framework. Please register it.

Definition at line 38 of file CbmCaParametersHandler.h.

Member Typedef Documentation

◆ ParametersPtr_t

using cbm::ca::ParametersHandler::ParametersPtr_t = std::shared_ptr<const cbm::algo::ca::Parameters<double>>

Definition at line 40 of file CbmCaParametersHandler.h.

Constructor & Destructor Documentation

◆ ParametersHandler() [1/3]

cbm::ca::ParametersHandler::ParametersHandler ( const ParametersHandler & )

delete

References ParametersHandler().

Referenced by ClassDefOverride(), Instance(), operator=(), operator=(), ParametersHandler(), and ParametersHandler().

◆ ParametersHandler() [2/3]

cbm::ca::ParametersHandler::ParametersHandler ( ParametersHandler && )

delete

References ParametersHandler().

◆ ParametersHandler() [3/3]

cbm::ca::ParametersHandler::ParametersHandler ( )

privatedefault

Default constructor.

◆ ~ParametersHandler()

cbm::ca::ParametersHandler::~ParametersHandler ( )

privatedefault

Destructor.

Member Function Documentation

◆ ClassDefOverride()

cbm::ca::ParametersHandler::ClassDefOverride	(	ParametersHandler	,
		0	)

private

References ParametersHandler().

◆ DisableStation()

void cbm::ca::ParametersHandler::DisableStation	(	algo::ca::EDetectorID	detId,
		int	locId )

inline

Disables tracking station.

Parameters

detId	Tracking detector identifier
locId	Local index of tracking station

Note: locId == -1 will disable all stations for the detId

Definition at line 58 of file CbmCaParametersHandler.h.

References fvInactiveIds.

◆ Get()

ParametersPtr_t cbm::ca::ParametersHandler::Get ( ) const

inline

Accessor to the parameters shared pointer.

Definition at line 49 of file CbmCaParametersHandler.h.

References fpParameters.

Referenced by cbm::ca::InputQaSetup::InitQa(), and cbm::ca::OutputQa::InitQa().

◆ Init()

InitStatus cbm::ca::ParametersHandler::Init ( )

overrideprotected

Initializes the instance.

Note: The function is called only once, if the instance was not initialized before

Definition at line 30 of file CbmCaParametersHandler.cxx.

References fbIgnoreHitPresence, fFldMode, fpParameters, fsMainConfig, fsOutFilename, fsUserConfig, fvInactiveIds, cbm::algo::kf::Original, cbm::ca::ParametersBuilder::SetMainConfig(), and cbm::algo::ca::ParametersIO::Store().

Referenced by ReInit().

◆ Instance()

ParametersHandler & cbm::ca::ParametersHandler::Instance ( )

static

Instance.

Definition at line 22 of file CbmCaParametersHandler.cxx.

References ParametersHandler().

Referenced by CbmOnlineParWrite::AddCa(), cbm::ca::InputQaSetup::InitQa(), and cbm::ca::OutputQa::InitQa().

◆ operator=() [1/2]

ParametersHandler & cbm::ca::ParametersHandler::operator= ( const ParametersHandler & )

delete

References ParametersHandler().

◆ operator=() [2/2]

ParametersHandler & cbm::ca::ParametersHandler::operator= ( ParametersHandler && )

delete

References ParametersHandler().

◆ ReInit()

InitStatus cbm::ca::ParametersHandler::ReInit ( )

overrideprotected

Re-initializes the instance.

Definition at line 71 of file CbmCaParametersHandler.cxx.

References fpParameters, and Init().

◆ SetFieldMode()

void cbm::ca::ParametersHandler::SetFieldMode ( algo::kf::EFieldMode fldMode )

inline

Sets the magnetic field mode.

Parameters

fldMode Magnetic field mode

Definition at line 70 of file CbmCaParametersHandler.h.

References fFldMode.

◆ SetIgnoreHitPresence()

void cbm::ca::ParametersHandler::SetIgnoreHitPresence ( bool ignoreHitPresence )

inline

Sets ignore hit presence.

Parameters

ignoreHitPresence If true, presence of hit branches is ignored

Definition at line 74 of file CbmCaParametersHandler.h.

References fbIgnoreHitPresence.

◆ SetMainConfig()

void cbm::ca::ParametersHandler::SetMainConfig ( const std::string & mainConfig )

inline

Sets path to the main config.

Parameters

mainConfig Path to the main config

Definition at line 62 of file CbmCaParametersHandler.h.

References fsMainConfig.

◆ SetUserConfig()

void cbm::ca::ParametersHandler::SetUserConfig ( const std::string & userConfig )

inline

Sets path to the user config.

Parameters

userConfig Path to the user config

Definition at line 66 of file CbmCaParametersHandler.h.

References fsUserConfig.

◆ StoreParameters()

void cbm::ca::ParametersHandler::StoreParameters ( const std::string & filename )

inline

Stores parameters in a file.

Parameters

filename A path to the parameters filename

Definition at line 78 of file CbmCaParametersHandler.h.

References fsOutFilename.

Member Data Documentation

◆ fbIgnoreHitPresence

bool cbm::ca::ParametersHandler::fbIgnoreHitPresence {false}

private

ignores hit presence, when checks active detectors

Definition at line 96 of file CbmCaParametersHandler.h.

Referenced by Init(), and SetIgnoreHitPresence().

◆ fFldMode

algo::kf::EFieldMode cbm::ca::ParametersHandler::fFldMode {algo::kf::EFieldMode::Original}

private

magnetic field mode

Definition at line 95 of file CbmCaParametersHandler.h.

Referenced by Init(), and SetFieldMode().

◆ fpParameters

ParametersPtr_t cbm::ca::ParametersHandler::fpParameters {nullptr}

private

ca::Parameters instance (double precision)

Definition at line 94 of file CbmCaParametersHandler.h.

Referenced by Get(), Init(), and ReInit().

◆ fsMainConfig

std::string cbm::ca::ParametersHandler::fsMainConfig {}

private

Main config.

Definition at line 90 of file CbmCaParametersHandler.h.

Referenced by Init(), and SetMainConfig().

◆ fsOutFilename

std::string cbm::ca::ParametersHandler::fsOutFilename {}

private

Parameters output filename.

Definition at line 92 of file CbmCaParametersHandler.h.

Referenced by Init(), and StoreParameters().

◆ fsUserConfig

std::string cbm::ca::ParametersHandler::fsUserConfig {}

private

User config.

Definition at line 91 of file CbmCaParametersHandler.h.

Referenced by Init(), and SetUserConfig().

◆ fvInactiveIds

std::vector<std::pair<algo::ca::EDetectorID, int> > cbm::ca::ParametersHandler::fvInactiveIds

private

Inactive stations.

Definition at line 93 of file CbmCaParametersHandler.h.

Referenced by DisableStation(), and Init().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ParametersPtr_t

Constructor & Destructor Documentation

◆ ParametersHandler() [1/3]

◆ ParametersHandler() [2/3]

◆ ParametersHandler() [3/3]

◆ ~ParametersHandler()

Member Function Documentation

◆ ClassDefOverride()

◆ DisableStation()

◆ Get()

◆ Init()

◆ Instance()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReInit()

◆ SetFieldMode()

◆ SetIgnoreHitPresence()

◆ SetMainConfig()

◆ SetUserConfig()

◆ StoreParameters()

Member Data Documentation

◆ fbIgnoreHitPresence

◆ fFldMode

◆ fpParameters

◆ fsMainConfig

◆ fsOutFilename

◆ fsUserConfig

◆ fvInactiveIds