CbmRoot
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CbmGeoSetup Class Reference

Data transfer object to represent the CBM Detector setup. More...

#include <CbmGeoSetup.h>

Collaboration diagram for CbmGeoSetup:
[legend]

Public Member Functions

Int_t GetId ()
 
std::string GetName ()
 
std::string GetTag ()
 
std::string GetAuthor ()
 
std::string GetDate ()
 
std::string GetRevision ()
 
std::string GetDescription ()
 
std::map< ECbmModuleId, CbmGeoSetupModule > & GetModuleMap ()
 
CbmGeoSetupField & GetField ()
 
CbmGeoSetupMedia & GetMedia ()
 
void SetId (Int_t value)
 
void SetName (std::string value)
 
void SetTag (std::string value)
 
void SetAuthor (std::string value)
 
void SetDate (std::string value)
 
void SetRevision (std::string value)
 
void SetDescription (std::string value)
 
void SetModuleMap (std::map< ECbmModuleId, CbmGeoSetupModule > value)
 
void SetField (CbmGeoSetupField value)
 
void SetMedia (CbmGeoSetupMedia value)
 

Private Member Functions

 ClassDefNV (CbmGeoSetup, 2)
 

Private Attributes

Int_t fId {}
 
std::string fName {}
 
std::string fTag {}
 
std::string fAuthor {}
 
std::string fDate {}
 
std::string fRevision {}
 
std::string fDescription {}
 
std::map< ECbmModuleId, CbmGeoSetupModule > fModuleMap {}
 
CbmGeoSetupField fField {}
 
CbmGeoSetupMedia fMedia {}
 

Detailed Description

Data transfer object to represent the CBM Detector setup.

Data transfer object to represent the CBM Detector setup module.

Data transfer object to represent the CBM Detector setup material properties.

Data transfer object to represent the magnetic field in CBM setup.

Has no real functionality apart from getters and setters It has a module map designated with module id (ECbmModuleId) and CbmSetupModule (CbmSetupModule), description of magnetic field and material properties.

Properties of this class are accessed from CbmSetup via CbmGeoSetupProvider

Has no real functionality apart from getters and setters

Definition at line 30 of file CbmGeoSetup.h.

Member Function Documentation

◆ ClassDefNV()

CbmGeoSetup::ClassDefNV ( CbmGeoSetup  ,
2   
)
private

◆ GetAuthor()

std::string CbmGeoSetup::GetAuthor ( )
inline

Definition at line 35 of file CbmGeoSetup.h.

References fAuthor.

◆ GetDate()

std::string CbmGeoSetup::GetDate ( )
inline

Definition at line 36 of file CbmGeoSetup.h.

References fDate.

◆ GetDescription()

std::string CbmGeoSetup::GetDescription ( )
inline

Definition at line 38 of file CbmGeoSetup.h.

References fDescription.

◆ GetField()

CbmGeoSetupField& CbmGeoSetup::GetField ( )
inline

Definition at line 42 of file CbmGeoSetup.h.

References fField.

Referenced by CbmSetup::CreateFieldMap(), CbmGeoSetupRepoProvider::GetFieldByTag(), CbmGeoSetupDbProvider::LoadSetup(), CbmSetup::SetField(), CbmSetup::SetFieldScale(), CbmGeoSetupProvider::SetFieldTag(), and CbmSetup::ToString().

◆ GetId()

Int_t CbmGeoSetup::GetId ( )
inline

Definition at line 32 of file CbmGeoSetup.h.

References fId.

Referenced by CbmGeoSetupDbProvider::LoadSetup().

◆ GetMedia()

CbmGeoSetupMedia& CbmGeoSetup::GetMedia ( )
inline

Definition at line 43 of file CbmGeoSetup.h.

References fMedia.

Referenced by CbmGeoSetupRepoProvider::GetMediaByTag(), CbmSetup::GetMediaFilePath(), CbmGeoSetupDbProvider::LoadSetup(), CbmGeoSetupProvider::RegisterSetup(), and CbmSetup::SetMediaFilePath().

◆ GetModuleMap()

std::map<ECbmModuleId, CbmGeoSetupModule>& CbmGeoSetup::GetModuleMap ( )
inline

Definition at line 39 of file CbmGeoSetup.h.

References fModuleMap.

Referenced by CbmSetup::GetGeoFileName(), CbmSetup::GetGeoTag(), CbmSetup::GetNofModules(), CbmGeoSetupRepoProvider::GetSetupByTag(), CbmSetup::IsActive(), CbmGeoSetupDbProvider::LoadSetup(), CbmGeoSetupProvider::RegisterSetup(), CbmGeoSetupProvider::RemoveModule(), CbmSetup::SetActive(), CbmSetup::SetModule(), CbmGeoSetupProvider::SetModuleTag(), and CbmSetup::ToString().

◆ GetName()

std::string CbmGeoSetup::GetName ( )
inline

Definition at line 33 of file CbmGeoSetup.h.

References fName.

Referenced by CbmGeoSetupProvider::RegisterSetup(), and CbmSetup::ToString().

◆ GetRevision()

std::string CbmGeoSetup::GetRevision ( )
inline

Definition at line 37 of file CbmGeoSetup.h.

References fRevision.

◆ GetTag()

std::string CbmGeoSetup::GetTag ( )
inline

Definition at line 34 of file CbmGeoSetup.h.

References fTag.

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

◆ SetAuthor()

void CbmGeoSetup::SetAuthor ( std::string  value)
inline

Definition at line 48 of file CbmGeoSetup.h.

References fAuthor.

◆ SetDate()

void CbmGeoSetup::SetDate ( std::string  value)
inline

Definition at line 49 of file CbmGeoSetup.h.

References fDate.

◆ SetDescription()

void CbmGeoSetup::SetDescription ( std::string  value)
inline

Definition at line 51 of file CbmGeoSetup.h.

References fDescription.

◆ SetField()

void CbmGeoSetup::SetField ( CbmGeoSetupField  value)
inline

Definition at line 55 of file CbmGeoSetup.h.

References fField.

Referenced by CbmGeoSetupRepoProvider::GetSetupByTag(), CbmGeoSetupDbProvider::LoadSetup(), CbmSetup::SetField(), and CbmGeoSetupProvider::SetFieldTag().

◆ SetId()

void CbmGeoSetup::SetId ( Int_t  value)
inline

Definition at line 45 of file CbmGeoSetup.h.

References fId.

Referenced by CbmGeoSetupDbProvider::GetSetupByTag().

◆ SetMedia()

void CbmGeoSetup::SetMedia ( CbmGeoSetupMedia  value)
inline

Definition at line 56 of file CbmGeoSetup.h.

References fMedia.

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

◆ SetModuleMap()

void CbmGeoSetup::SetModuleMap ( std::map< ECbmModuleId, CbmGeoSetupModule >  value)
inline

Definition at line 52 of file CbmGeoSetup.h.

References fModuleMap.

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

◆ SetName()

void CbmGeoSetup::SetName ( std::string  value)
inline

Definition at line 46 of file CbmGeoSetup.h.

References fName.

Referenced by CbmGeoSetupRepoProvider::GetSetupByTag().

◆ SetRevision()

void CbmGeoSetup::SetRevision ( std::string  value)
inline

Definition at line 50 of file CbmGeoSetup.h.

References fRevision.

◆ SetTag()

void CbmGeoSetup::SetTag ( std::string  value)
inline

Definition at line 47 of file CbmGeoSetup.h.

References fTag.

Referenced by CbmGeoSetupRepoProvider::GetSetupByTag().

Member Data Documentation

◆ fAuthor

std::string CbmGeoSetup::fAuthor {}
private

Definition at line 62 of file CbmGeoSetup.h.

Referenced by GetAuthor(), and SetAuthor().

◆ fDate

std::string CbmGeoSetup::fDate {}
private

Definition at line 63 of file CbmGeoSetup.h.

Referenced by GetDate(), and SetDate().

◆ fDescription

std::string CbmGeoSetup::fDescription {}
private

Definition at line 65 of file CbmGeoSetup.h.

Referenced by GetDescription(), and SetDescription().

◆ fField

CbmGeoSetupField CbmGeoSetup::fField {}
private

Definition at line 67 of file CbmGeoSetup.h.

Referenced by GetField(), and SetField().

◆ fId

Int_t CbmGeoSetup::fId {}
private

Definition at line 59 of file CbmGeoSetup.h.

Referenced by GetId(), and SetId().

◆ fMedia

CbmGeoSetupMedia CbmGeoSetup::fMedia {}
private

Definition at line 68 of file CbmGeoSetup.h.

Referenced by GetMedia(), and SetMedia().

◆ fModuleMap

std::map<ECbmModuleId, CbmGeoSetupModule> CbmGeoSetup::fModuleMap {}
private

Definition at line 66 of file CbmGeoSetup.h.

Referenced by GetModuleMap(), and SetModuleMap().

◆ fName

std::string CbmGeoSetup::fName {}
private

Definition at line 60 of file CbmGeoSetup.h.

Referenced by GetName(), and SetName().

◆ fRevision

std::string CbmGeoSetup::fRevision {}
private

Definition at line 64 of file CbmGeoSetup.h.

Referenced by GetRevision(), and SetRevision().

◆ fTag

std::string CbmGeoSetup::fTag {}
private

Definition at line 61 of file CbmGeoSetup.h.

Referenced by GetTag(), and SetTag().

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