Setup provider with database functionality. More...

#include <CbmGeoSetupDbProvider.h>

Inheritance diagram for CbmGeoSetupDbProvider:

Collaboration diagram for CbmGeoSetupDbProvider:

Public Member Functions
virtual std::vector< std::string >	GetSetupTags ()
	Abstract method to get the list of setup tags.

virtual std::vector< std::string >	GetFieldTags ()
	Abstract method to get the list of field tags.

virtual std::vector< std::string >	GetMediaTags ()
	Abstract method to get the list of media tags.

virtual CbmGeoSetup	GetSetupByTag (std::string setupTag, std::string revision)
	Abstract method for constructing the setup by id and tag.

virtual CbmGeoSetupModule	GetModuleByTag (ECbmModuleId moduleId, std::string tag)
	Abstract method for constructing the module by id and tag.

virtual CbmGeoSetupField	GetFieldByTag (std::string tag)
	Abstract method for constructing the field by tag.

virtual CbmGeoSetupMedia	GetMediaByTag (std::string tag)
	Abstract method for constructing the media by tag.

virtual void	LoadSetup (std::string setupTag, std::string revision="")
	Abstract method to load the setup with a tag and revision version.

void	SetModuleTag (ECbmModuleId moduleId, std::string tag, Bool_t active)
	Loads the detector with a tag into setup, will invoke GetModuleByTag.

void	RemoveModule (ECbmModuleId moduleId)
	Removes the module from setup.

void	SetFieldTag (std::string tag)
	Loads the field with a tag and adds it to the setup.

void	RegisterSetup ()
	Registers the previously loaded setup with FairRoot. Replaces the registerSetup.C macro.

void	Reset ()
	Resets the setup to default (empty)

CbmGeoSetup &	GetSetup ()
	Direct access to underlying geometry setup representation. Allows for fine-tuning of parameters, for exmaple, transformation matrices.

Protected Member Functions
CbmGeoSetupModule	GetDefaultCaveModule ()
	Gets defauk cave if none was provided by the other means.

Protected Attributes
CbmGeoSetup	fSetup {}

Private Member Functions
	ClassDef (CbmGeoSetupDbProvider, 1)

Detailed Description

Setup provider with database functionality.

This class implements the CbmGeoSetupProvider interface to fetch available setups, fields and media definitions from DB. Database functionality is described in http://lt-jds.jinr.ru/record/72420 This class works with a local SQLite replica of the real geometry database hosted elsewhere. See CMakeLists.txt for replica loading configuration.

Definition at line 25 of file CbmGeoSetupDbProvider.h.

Member Function Documentation

◆ ClassDef()

CbmGeoSetupDbProvider::ClassDef	(	CbmGeoSetupDbProvider	,
		1	)

private

◆ GetDefaultCaveModule()

CbmGeoSetupModule CbmGeoSetupProvider::GetDefaultCaveModule ( )

protectedinherited

Gets defauk cave if none was provided by the other means.

Definition at line 159 of file CbmGeoSetupProvider.cxx.

Referenced by CbmGeoSetupRepoProvider::GetSetupByTag(), and LoadSetup().

◆ GetFieldByTag()

CbmGeoSetupField CbmGeoSetupDbProvider::GetFieldByTag ( std::string tag )

virtual

Abstract method for constructing the field by tag.

Implements CbmGeoSetupProvider.

Definition at line 225 of file CbmGeoSetupDbProvider.cxx.

References CbmGeoSetupField::GetMatrix(), CbmGeoSetupField::SetAuthor(), CbmGeoSetupField::SetDate(), CbmGeoSetupField::SetDescription(), CbmGeoSetupField::SetFilePath(), CbmGeoSetupField::SetId(), CbmGeoSetupField::SetScale(), and CbmGeoSetupField::SetTag().

Referenced by LoadSetup().

◆ GetFieldTags()

std::vector< std::string > CbmGeoSetupDbProvider::GetFieldTags ( )

virtual

Abstract method to get the list of field tags.

Implements CbmGeoSetupProvider.

Definition at line 119 of file CbmGeoSetupDbProvider.cxx.

◆ GetMediaByTag()

CbmGeoSetupMedia CbmGeoSetupDbProvider::GetMediaByTag ( std::string tag )

virtual

Abstract method for constructing the media by tag.

Implements CbmGeoSetupProvider.

Definition at line 263 of file CbmGeoSetupDbProvider.cxx.

References CbmGeoSetupMedia::SetAuthor(), CbmGeoSetupMedia::SetDate(), CbmGeoSetupMedia::SetDescription(), CbmGeoSetupMedia::SetFilePath(), CbmGeoSetupMedia::SetId(), and CbmGeoSetupMedia::SetTag().

Referenced by LoadSetup().

◆ GetMediaTags()

std::vector< std::string > CbmGeoSetupDbProvider::GetMediaTags ( )

virtual

Abstract method to get the list of media tags.

Implements CbmGeoSetupProvider.

Definition at line 121 of file CbmGeoSetupDbProvider.cxx.

◆ GetModuleByTag()

CbmGeoSetupModule CbmGeoSetupDbProvider::GetModuleByTag	(	ECbmModuleId	moduleId,
		std::string	tag )

virtual

Abstract method for constructing the module by id and tag.

Implements CbmGeoSetupProvider.

Definition at line 175 of file CbmGeoSetupDbProvider.cxx.

Referenced by LoadSetup().

◆ GetSetup()

CbmGeoSetup & CbmGeoSetupProvider::GetSetup ( )

inlineinherited

Direct access to underlying geometry setup representation. Allows for fine-tuning of parameters, for exmaple, transformation matrices.

Definition at line 68 of file CbmGeoSetupProvider.h.

References CbmGeoSetupProvider::fSetup.

Referenced by CbmSetup::CreateFieldMap(), CbmSetup::GetGeoFileName(), CbmSetup::GetGeoTag(), CbmSetup::GetHash(), CbmSetup::GetMediaFilePath(), CbmSetup::GetNofModules(), cbm::kf::TrackingSetupBuilder::Instance(), CbmSetup::IsActive(), CbmSetup::SetActive(), CbmSetup::SetField(), CbmSetup::SetFieldScale(), CbmSetup::SetMediaFilePath(), CbmSetup::SetModule(), and CbmSetup::ToString().

◆ GetSetupByTag()

CbmGeoSetup CbmGeoSetupDbProvider::GetSetupByTag	(	std::string	setupTag,
		std::string	revision )

virtual

Abstract method for constructing the setup by id and tag.

Implements CbmGeoSetupProvider.

Definition at line 124 of file CbmGeoSetupDbProvider.cxx.

References CbmGeoSetup::GetField(), CbmGeoSetup::GetMedia(), pos, CbmGeoSetup::SetAuthor(), CbmGeoSetup::SetDate(), CbmGeoSetup::SetDescription(), CbmGeoSetup::SetId(), CbmGeoSetup::SetName(), CbmGeoSetup::SetRevision(), CbmGeoSetup::SetTag(), CbmGeoSetupField::SetTag(), and CbmGeoSetupMedia::SetTag().

Referenced by LoadSetup().

◆ GetSetupTags()

std::vector< std::string > CbmGeoSetupDbProvider::GetSetupTags ( )

virtual

Abstract method to get the list of setup tags.

Implements CbmGeoSetupProvider.

Definition at line 99 of file CbmGeoSetupDbProvider.cxx.

◆ LoadSetup()

void CbmGeoSetupDbProvider::LoadSetup	(	std::string	setupTag,
		std::string	revision = "" )

virtual

Abstract method to load the setup with a tag and revision version.

Implements CbmGeoSetupProvider.

Definition at line 294 of file CbmGeoSetupDbProvider.cxx.

References CbmGeoSetupProvider::fSetup, CbmGeoSetupProvider::GetDefaultCaveModule(), CbmGeoSetup::GetField(), GetFieldByTag(), CbmGeoSetup::GetId(), CbmGeoSetup::GetMedia(), GetMediaByTag(), GetModuleByTag(), CbmGeoSetup::GetModuleMap(), GetSetupByTag(), CbmGeoSetup::GetTag(), CbmGeoSetupField::GetTag(), CbmGeoSetupMedia::GetTag(), kCave, CbmGeoSetup::SetField(), CbmGeoSetup::SetMedia(), and CbmGeoSetup::SetModuleMap().

◆ RegisterSetup()

void CbmGeoSetupProvider::RegisterSetup ( )

inherited

Registers the previously loaded setup with FairRoot. Replaces the registerSetup.C macro.

Definition at line 75 of file CbmGeoSetupProvider.cxx.

References counter, CbmGeoSetupProvider::fSetup, CbmGeoSetupMedia::GetFilePath(), CbmGeoSetup::GetMedia(), CbmGeoSetup::GetModuleMap(), CbmGeoSetup::GetName(), kBmon, kCave, kFsd, kHodo, kMagnet, kMuch, kMvd, kNofSystems, kPipe, kPlatform, kPsd, kRich, kSts, kTarget, kTof, and kTrd.

Referenced by CbmSetup::RegisterSetup().

◆ RemoveModule()

void CbmGeoSetupProvider::RemoveModule ( ECbmModuleId moduleId )

inherited

Removes the module from setup.

Definition at line 63 of file CbmGeoSetupProvider.cxx.

References CbmGeoSetupProvider::fSetup, and CbmGeoSetup::GetModuleMap().

Referenced by CbmSetup::RemoveModule().

◆ Reset()

void CbmGeoSetupProvider::Reset ( )

inherited

Resets the setup to default (empty)

Definition at line 157 of file CbmGeoSetupProvider.cxx.

References CbmGeoSetupProvider::fSetup.

Referenced by CbmSetup::Clear().

◆ SetFieldTag()

void CbmGeoSetupProvider::SetFieldTag ( std::string tag )

inherited

Loads the field with a tag and adds it to the setup.

Parameters

tag	field tag to load

Definition at line 65 of file CbmGeoSetupProvider.cxx.

References CbmGeoSetupProvider::fSetup, CbmGeoSetup::GetField(), CbmGeoSetupProvider::GetFieldByTag(), CbmGeoSetupField::GetMatrix(), CbmGeoSetupField::GetScale(), CbmGeoSetup::SetField(), CbmGeoSetupField::SetMatrix(), and CbmGeoSetupField::SetScale().

◆ SetModuleTag()

void CbmGeoSetupProvider::SetModuleTag	(	ECbmModuleId	moduleId,
		std::string	tag,
		Bool_t	active )

inherited

Loads the detector with a tag into setup, will invoke GetModuleByTag.

Parameters

moduleId	ECbmModuleId @patam tag module tag to load
active	indicates if the module will be treated as active in Monte-Carlo, exact treatment depends on actual implementation of a FairModule

Note: This method has a side effect for backward compatibility -when loading the magnet module, the field with the same tag will be auto-loaded.

Definition at line 56 of file CbmGeoSetupProvider.cxx.

References CbmGeoSetupProvider::fSetup, CbmGeoSetupProvider::GetModuleByTag(), and CbmGeoSetup::GetModuleMap().

Referenced by CbmSetup::SetModule().

Member Data Documentation

◆ fSetup

CbmGeoSetup CbmGeoSetupProvider::fSetup {}

protectedinherited

Definition at line 94 of file CbmGeoSetupProvider.h.

Referenced by CbmGeoSetupRepoProvider::GetFieldByTag(), CbmGeoSetupRepoProvider::GetMediaByTag(), CbmGeoSetupProvider::GetSetup(), CbmGeoSetupRepoProvider::GetSetupByTag(), LoadSetup(), CbmGeoSetupRepoProvider::LoadSetup(), CbmGeoSetupProvider::RegisterSetup(), CbmGeoSetupProvider::RemoveModule(), CbmGeoSetupProvider::Reset(), CbmGeoSetupProvider::SetFieldTag(), and CbmGeoSetupProvider::SetModuleTag().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ ClassDef()

◆ GetDefaultCaveModule()

◆ GetFieldByTag()

◆ GetFieldTags()

◆ GetMediaByTag()

◆ GetMediaTags()

◆ GetModuleByTag()

◆ GetSetup()

◆ GetSetupByTag()

◆ GetSetupTags()

◆ LoadSetup()

◆ RegisterSetup()

◆ RemoveModule()

◆ Reset()

◆ SetFieldTag()

◆ SetModuleTag()

Member Data Documentation

◆ fSetup