Setup meta info for the TRD system to supplement the geometry. More...

#include <CbmTrdGeoSetup.h>

Inheritance diagram for cbm::trd::geo::Setup:

Collaboration diagram for cbm::trd::geo::Setup:

Classes
class	Asic
	Meta info for one TRD ASIC. More...

class	Module
	Meta info for one TRD module. More...

Public Member Functions
	Setup (const char n, const char t)
	Setup descriptor for the TRD setup. The identification should be :

virtual	~Setup ()

virtual const char *	GetInfo (const char *label) const
	Retrieve meta info for the setup according to label.

virtual int	GetModuleId (int i) const
	Get module par by index.

virtual const Module *	GetModulePar (int detId) const
	Get module par by detector id.

virtual size_t	GetNrOfModules () const
	Retrieve no of modules in the setup.

vector< Module * >	GetModules ()
	Retrieve full list of modules in the setup.

virtual void	addParam (Module *mod)

virtual void	putParams (FairParamList *)
	Write out the setup from object to FairParamList.

virtual bool	getParams (FairParamList *)
	Read in the setup from FairParamList.

Protected Attributes
int	fVersion = 1

eGas	fGas = eGas::kNotSet

vector< Module * >	fModule = {}
	list of modules defined in the setup

vector< string >	fMetaFields = {}
	ordered list of meta info types

map< string, string >	fMeta = {}
	meta info attached to this setup

Private Member Functions
	Setup (const Setup &)

void	Help (const char *lab=nullptr) const
	Help message for user.

size_t	Parse ()
	Parse setup description for meta info.

Friends
class	SetupManager

Detailed Description

Setup meta info for the TRD system to supplement the geometry.

Definition at line 46 of file CbmTrdGeoSetup.h.

Constructor & Destructor Documentation

◆ Setup() [1/2]

Setup::Setup	(	const char *	n,
		const char *	t )

Setup descriptor for the TRD setup. The identification should be :

Parameters

[in]	n	identification of geometry setup to which it is linked.
[in]	t	responsible name, email and date of creation.

Define complementing info besides the geo description for the TRD system setup. n = geo tag; e.g. for "trd_v22d_mcbm.geo.root" name = "v22d_mcbm" t = meta info; list of ";" separated information in the following order

"name" : responsible person's name
"email" : responsible person's email
"date" : date of creation

Definition at line 106 of file CbmTrdGeoSetup.cxx.

References fMeta, fMetaFields, Help(), and Parse().

◆ ~Setup()

Setup::~Setup ( )

virtual

Definition at line 172 of file CbmTrdGeoSetup.cxx.

References fModule.

◆ Setup() [2/2]

cbm::trd::geo::Setup::Setup ( const Setup & )

private

Member Function Documentation

◆ addParam()

void Setup::addParam ( Module * mod )

virtual

Definition at line 266 of file CbmTrdGeoSetup.cxx.

References fModule.

Referenced by cbm::trd::geo::SetupManager::Init().

◆ GetInfo()

const char * Setup::GetInfo ( const char * label ) const

virtual

Retrieve meta info for the setup according to label.

See also: Setup().

Parameters

[in] label description of the meta info to be retrieved. In case of un-registered label return nullptr;

Definition at line 133 of file CbmTrdGeoSetup.cxx.

References fMeta, and Help().

◆ GetModuleId()

int Setup::GetModuleId ( int i ) const

virtual

Get module par by index.

Parameters

[in] i index of the module in the list

Definition at line 175 of file CbmTrdGeoSetup.cxx.

References fModule, and GetNrOfModules().

◆ GetModulePar()

const Setup::Module * Setup::GetModulePar ( int detId ) const

virtual

Get module par by detector id.

Parameters

[in] detId detector id in the setup

Definition at line 186 of file CbmTrdGeoSetup.cxx.

References fModule.

◆ GetModules()

vector< Module * > cbm::trd::geo::Setup::GetModules ( )

inline

Retrieve full list of modules in the setup.

Definition at line 71 of file CbmTrdGeoSetup.h.

References fModule.

◆ GetNrOfModules()

virtual size_t cbm::trd::geo::Setup::GetNrOfModules ( ) const

inlinevirtual

Retrieve no of modules in the setup.

Definition at line 69 of file CbmTrdGeoSetup.h.

References fModule.

Referenced by GetModuleId(), and putParams().

◆ getParams()

bool Setup::getParams ( FairParamList * l )

virtual

Read in the setup from FairParamList.

Definition at line 194 of file CbmTrdGeoSetup.cxx.

References fGas, fModule, fVersion, cbm::trd::kAr, and cbm::trd::kXe.

◆ Help()

void Setup::Help ( const char * lab = nullptr ) const

private

Help message for user.

Definition at line 143 of file CbmTrdGeoSetup.cxx.

References fMeta, and lab.

Referenced by GetInfo(), and Setup().

◆ Parse()

size_t Setup::Parse ( )

private

Parse setup description for meta info.

Definition at line 159 of file CbmTrdGeoSetup.cxx.

References fMeta, and fMetaFields.

Referenced by Setup().

◆ putParams()

void Setup::putParams ( FairParamList * l )

virtual

Write out the setup from object to FairParamList.

Definition at line 241 of file CbmTrdGeoSetup.cxx.

References fGas, fModule, fVersion, GetNrOfModules(), cbm::trd::k1d, and cbm::trd::kAr.

Friends And Related Symbol Documentation

◆ SetupManager

friend class SetupManager

friend

Definition at line 48 of file CbmTrdGeoSetup.h.

Member Data Documentation

◆ fGas

eGas cbm::trd::geo::Setup::fGas = eGas::kNotSet

protected

Definition at line 80 of file CbmTrdGeoSetup.h.

Referenced by getParams(), cbm::trd::geo::Setup::Module::init(), and putParams().

◆ fMeta

map<string, string> cbm::trd::geo::Setup::fMeta = {}

protected

meta info attached to this setup

Definition at line 83 of file CbmTrdGeoSetup.h.

Referenced by GetInfo(), Help(), Parse(), and Setup().

◆ fMetaFields

vector<string> cbm::trd::geo::Setup::fMetaFields = {}

protected

ordered list of meta info types

Definition at line 82 of file CbmTrdGeoSetup.h.

Referenced by Parse(), and Setup().

◆ fModule

vector<Module*> cbm::trd::geo::Setup::fModule = {}

protected

list of modules defined in the setup

Definition at line 81 of file CbmTrdGeoSetup.h.

Referenced by addParam(), GetModuleId(), GetModulePar(), GetModules(), GetNrOfModules(), getParams(), putParams(), and ~Setup().

◆ fVersion

int cbm::trd::geo::Setup::fVersion = 1

protected

Definition at line 79 of file CbmTrdGeoSetup.h.

Referenced by getParams(), and putParams().

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

Classes

Public Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Setup() [1/2]

◆ ~Setup()

◆ Setup() [2/2]

Member Function Documentation

◆ addParam()

◆ GetInfo()

◆ GetModuleId()

◆ GetModulePar()

◆ GetModules()

◆ GetNrOfModules()

◆ getParams()

◆ Help()

◆ Parse()

◆ putParams()

Friends And Related Symbol Documentation

◆ SetupManager

Member Data Documentation

◆ fGas

◆ fMeta

◆ fMetaFields

◆ fModule

◆ fVersion