CbmRoot
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
RunDatabaseContainer Class Reference

#include <CbmRunDatabaseContainer.h>

Inheritance diagram for RunDatabaseContainer:
[legend]
Collaboration diagram for RunDatabaseContainer:
[legend]

Public Member Functions

 RunDatabaseContainer (const RunDatabaseContainer &)=delete
 Disable copy and move.
 
 RunDatabaseContainer (RunDatabaseContainer &&)=delete
 
RunDatabaseContainer & operator= (const RunDatabaseContainer &)=delete
 
RunDatabaseContainer & operator= (RunDatabaseContainer &&)=delete
 
const std::string & GetBmonCalibrationTag () const
 Returns tag of BMON calibration for a provided run ID.
 
const std::string & GetGeoSetupTag () const
 Returns tag of the geometry setup for a provided run ID.
 
const std::string & GetTofCalibrationTag () const
 Returns tag of TOF calibration for a provided run ID.
 
const std::string & GetAlignmentTag () const
 Returns tag of alignment matrices (geoSetup + ref. run ID)
 
const std::string & GetRecoParTag () const
 Returns tag of reconstruction parameter.
 
std::string GetRecoParDir () const
 Returns a path to the reconstruction parameter directory.
 
uint64_t GetRunStartTime () const
 Returns the run start time in UTC seconds for the selected run ID.
 
const uint64_t & GetRunStartTimeNs () const
 Returns the run start time in UTC nanoseconds for the selected run ID.
 
std::string GetAlgoMainConfigPath () const
 Returns a path to the main configuration file of the online reconstruction.
 
uint32_t GetRunId () const
 Returns the loaded run ID.
 
bool LoadRun (uint32_t runId)
 Loads the information for the run from the file.
 
void SetPathCommonDb (const std::string &pathCommonDb)
 Sets an alternative path to the common DB file.
 
void SetPathRunStartTimeDb (const std::string &pathRunStartTimeDb)
 Sets an alternative path to run starttime DB file.
 
std::string ToString () const
 String representation of the class contents.
 

Static Public Member Functions

static RunDatabaseContainer & Instance ()
 Instance access.
 

Private Member Functions

 RunDatabaseContainer ()
 Default constructor.
 
 ~RunDatabaseContainer ()=default
 Destructor.
 

Private Attributes

std::string fPathCommonDb
 Path to the common data-base.
 
std::string fPathRunStartTimeDb
 Path to the runtime data-base.
 
std::string fBmonCalibrationTag
 BMON calibration tag for a given run ID.
 
std::string fTofCalibrationTag
 TOF calibration tag for a given run ID.
 
std::string fGeoSetupTag
 Geometry setup tag for a given run ID.
 
std::string fAlignmentTag
 Tag for alignment matrices.
 
std::string fRecoParTag
 Tag for reconstruction parameters for a given run ID.
 
uint64_t fRunStartTimeNs
 Run start time since the epoch [ns].
 
uint32_t fRunId {0}
 Current run ID.
 

Detailed Description

Definition at line 19 of file CbmRunDatabaseContainer.h.

Constructor & Destructor Documentation

◆ RunDatabaseContainer() [1/3]

cbm::RunDatabaseContainer::RunDatabaseContainer ( const RunDatabaseContainer & )
delete

Disable copy and move.

◆ RunDatabaseContainer() [2/3]

cbm::RunDatabaseContainer::RunDatabaseContainer ( RunDatabaseContainer && )
delete

◆ RunDatabaseContainer() [3/3]

RunDatabaseContainer::RunDatabaseContainer ( )
private

Default constructor.

Definition at line 20 of file CbmRunDatabaseContainer.cxx.

◆ ~RunDatabaseContainer()

cbm::RunDatabaseContainer::~RunDatabaseContainer ( )
privatedefault

Destructor.

Member Function Documentation

◆ GetAlgoMainConfigPath()

std::string cbm::RunDatabase::GetAlgoMainConfigPath ( ) const
inlineinherited

Returns a path to the main configuration file of the online reconstruction.

Note
The path is RELATIVE to ${VMCWORKDIR}

Definition at line 104 of file CbmRunDatabase.h.

References GetRecoParDir().

◆ GetAlignmentTag()

const std::string & cbm::RunDatabase::GetAlignmentTag ( ) const
inlineinherited

Returns tag of alignment matrices (geoSetup + ref. run ID)

Definition at line 87 of file CbmRunDatabase.h.

References fAlignmentTag.

Referenced by CbmOnlineParWrite::Run().

◆ GetBmonCalibrationTag()

const std::string & cbm::RunDatabase::GetBmonCalibrationTag ( ) const
inlineinherited

Returns tag of BMON calibration for a provided run ID.

Definition at line 78 of file CbmRunDatabase.h.

References fBmonCalibrationTag.

◆ GetGeoSetupTag()

const std::string & cbm::RunDatabase::GetGeoSetupTag ( ) const
inlineinherited

Returns tag of the geometry setup for a provided run ID.

Definition at line 81 of file CbmRunDatabase.h.

References fGeoSetupTag.

Referenced by CbmOnlineParWrite::Run().

◆ GetRecoParDir()

std::string cbm::RunDatabase::GetRecoParDir ( ) const
inlineinherited

Returns a path to the reconstruction parameter directory.

Note
The path is RELATIVE to ${VMCWORKDIR}

Definition at line 94 of file CbmRunDatabase.h.

References fRecoParTag.

Referenced by GetAlgoMainConfigPath().

◆ GetRecoParTag()

const std::string & cbm::RunDatabase::GetRecoParTag ( ) const
inlineinherited

Returns tag of reconstruction parameter.

Definition at line 90 of file CbmRunDatabase.h.

References fRecoParTag.

◆ GetRunId()

uint32_t cbm::RunDatabase::GetRunId ( ) const
inlineinherited

Returns the loaded run ID.

Definition at line 107 of file CbmRunDatabase.h.

References fRunId.

◆ GetRunStartTime()

uint64_t cbm::RunDatabase::GetRunStartTime ( ) const
inlineinherited

Returns the run start time in UTC seconds for the selected run ID.

Definition at line 97 of file CbmRunDatabase.h.

References fRunStartTimeNs.

◆ GetRunStartTimeNs()

const uint64_t & cbm::RunDatabase::GetRunStartTimeNs ( ) const
inlineinherited

Returns the run start time in UTC nanoseconds for the selected run ID.

Definition at line 100 of file CbmRunDatabase.h.

References fRunStartTimeNs.

◆ GetTofCalibrationTag()

const std::string & cbm::RunDatabase::GetTofCalibrationTag ( ) const
inlineinherited

Returns tag of TOF calibration for a provided run ID.

Definition at line 84 of file CbmRunDatabase.h.

References fTofCalibrationTag.

Referenced by CbmOnlineParWrite::AddTof().

◆ Instance()

RunDatabaseContainer & RunDatabaseContainer::Instance ( )
static

Instance access.

Definition at line 34 of file CbmRunDatabaseContainer.cxx.

◆ LoadRun()

bool RunDatabase::LoadRun ( uint32_t runId)
inherited

Loads the information for the run from the file.

Parameters
runIdRun identifier
Returns
true The database was read successfully
false The database contains undefined/inconsistent parameters

Definition at line 20 of file CbmRunDatabase.cxx.

References fAlignmentTag, fBmonCalibrationTag, fGeoSetupTag, fPathCommonDb, fPathRunStartTimeDb, fRecoParTag, fRunId, fRunStartTimeNs, fTofCalibrationTag, and cbm::util::yaml::ReadFromFile().

◆ operator=() [1/2]

RunDatabaseContainer & cbm::RunDatabaseContainer::operator= ( const RunDatabaseContainer & )
delete

◆ operator=() [2/2]

RunDatabaseContainer & cbm::RunDatabaseContainer::operator= ( RunDatabaseContainer && )
delete

◆ SetPathCommonDb()

void cbm::RunDatabase::SetPathCommonDb ( const std::string & pathCommonDb)
inlineinherited

Sets an alternative path to the common DB file.

Parameters
pathCommonDbthe path

Definition at line 117 of file CbmRunDatabase.h.

References fPathCommonDb.

Referenced by cbm::RunDatabaseContainer::RunDatabaseContainer().

◆ SetPathRunStartTimeDb()

void cbm::RunDatabase::SetPathRunStartTimeDb ( const std::string & pathRunStartTimeDb)
inlineinherited

Sets an alternative path to run starttime DB file.

Parameters
pathRunStartTimeDbthe path

Definition at line 121 of file CbmRunDatabase.h.

References fPathRunStartTimeDb.

Referenced by cbm::RunDatabaseContainer::RunDatabaseContainer().

◆ ToString()

std::string RunDatabase::ToString ( ) const
inherited

String representation of the class contents.

Definition at line 81 of file CbmRunDatabase.cxx.

References fBmonCalibrationTag, fGeoSetupTag, fRecoParTag, fRunId, fRunStartTimeNs, and fTofCalibrationTag.

Member Data Documentation

◆ fAlignmentTag

std::string cbm::RunDatabase::fAlignmentTag
privateinherited

Tag for alignment matrices.

Definition at line 135 of file CbmRunDatabase.h.

Referenced by GetAlignmentTag(), and LoadRun().

◆ fBmonCalibrationTag

std::string cbm::RunDatabase::fBmonCalibrationTag
privateinherited

BMON calibration tag for a given run ID.

Definition at line 132 of file CbmRunDatabase.h.

Referenced by GetBmonCalibrationTag(), LoadRun(), and ToString().

◆ fGeoSetupTag

std::string cbm::RunDatabase::fGeoSetupTag
privateinherited

Geometry setup tag for a given run ID.

Definition at line 134 of file CbmRunDatabase.h.

Referenced by GetGeoSetupTag(), LoadRun(), and ToString().

◆ fPathCommonDb

std::string cbm::RunDatabase::fPathCommonDb
privateinherited

Path to the common data-base.

Definition at line 128 of file CbmRunDatabase.h.

Referenced by LoadRun(), and SetPathCommonDb().

◆ fPathRunStartTimeDb

std::string cbm::RunDatabase::fPathRunStartTimeDb
privateinherited

Path to the runtime data-base.

Definition at line 129 of file CbmRunDatabase.h.

Referenced by LoadRun(), and SetPathRunStartTimeDb().

◆ fRecoParTag

std::string cbm::RunDatabase::fRecoParTag
privateinherited

Tag for reconstruction parameters for a given run ID.

Definition at line 136 of file CbmRunDatabase.h.

Referenced by GetRecoParDir(), GetRecoParTag(), LoadRun(), and ToString().

◆ fRunId

uint32_t cbm::RunDatabase::fRunId {0}
privateinherited

Current run ID.

Definition at line 138 of file CbmRunDatabase.h.

Referenced by GetRunId(), LoadRun(), and ToString().

◆ fRunStartTimeNs

uint64_t cbm::RunDatabase::fRunStartTimeNs
privateinherited

Run start time since the epoch [ns].

Definition at line 137 of file CbmRunDatabase.h.

Referenced by GetRunStartTime(), GetRunStartTimeNs(), LoadRun(), and ToString().

◆ fTofCalibrationTag

std::string cbm::RunDatabase::fTofCalibrationTag
privateinherited

TOF calibration tag for a given run ID.

Definition at line 133 of file CbmRunDatabase.h.

Referenced by GetTofCalibrationTag(), LoadRun(), and ToString().

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