BmnFunctionSet.h

Go to the documentation of this file.

#ifndef BMNFUNCTIONSET_H
#define BMNFUNCTIONSET_H 1
 
// ROOT
#include "TDatime.h"
#include "TString.h"
#include "TSystem.h"
#include "TTimeStamp.h"
 
#include <TFile.h>
 
// STL
#include <chrono>
#include <string>
#include <vector>
 
using SysClock = std::chrono::system_clock;
using SysPoint = std::chrono::time_point<SysClock>;
 
/** Class with static common functions to simplify experiment code **/
class BmnFunctionSet
{
  public:
    // check whether path is a directory
    static bool isDirectory(TString path);
    // check whether file exists: 1 - exists, 0 - not exists, -1 - exists but cannot access with the mode (default:
    // kFileExists) fileName: file path; iVerbose: 0 - no output, 1 - print errors; mode: check for 'kFileExists', or
    // has 'kExecutePermission', 'kWritePermission' or 'kReadPermission'
    static int CheckFileExist(TString& fileName, int iVerbose = 0, EAccessMode mode = kFileExists);
    // check whether directory exists: 1 - exists, 0 - not exists, -1 - exists but cannot access with the mode (default:
    // kFileExists)
    static int CheckDirectoryExist(TString& fileName, int iVerbose = 0, EAccessMode mode = kFileExists);
    // create directory tree for the file name if not exists: 1 - exists, 0 - created
    // error codes: -1 - exists but cannot access with the mode (default: kWritePermission), -2 - cannot be created, -3
    // - empty file name
    static int CreateDirectoryTree(TString& fileName, int iVerbose = 0, EAccessMode mode = kWritePermission);
    // get the list of input ROOT files for the given input file, which can be a ROOT file with data, a ROOT file with
    // a TChain object or a text file (extension is not '.root') with a list of ROOT files:
    // inputFileName: path to the input file; fileList: returns the list of ROOT files with expanded paths
    // return value: number of files in the list, < 0 - error codes
    static int GetInputFileList(TString inputFileName, std::vector<TString>& fileList);
 
    // define whether ROOT file contains simulation data: 1 - true, 0 - false (experimental data), <0 - some errors
    // occured if filename is not set then the function checks the current processing
    static int isSimulationFile(TString fileName = "");
    // method_number: 0 - find FairRtdbRun with period number name; 1 - use "FileHeader" (FairFileHeader)
    static int GetPeriodNumber(TFile* root_file, int method_number = 0);
 
    // parsing file name to define beam, target and energy of the run
    // the file name is parsed with the '_' separator, if it does not fit then with the '.' separator
    // file_name: name of the file to parse
    // result (beam, target, energy (GeV)) returns via links, energy is < 0 in case of errors
    // return value: 0 - success, < 0 - error codes
    static Int_t ParseFileName(const TString& file_name, TString& beam, TString& target, Double_t& energy);
 
    // parsing the geometry tag, which can contain the path to an XML file with a local customization of the setup
    // (see database/geo_db/examples/README.md) after the ';' separator, e.g. "run9_26.09.0;$VMCWORKDIR/my_setup.xml"
    // If no XML file is given after the separator then the whole value is considered as the setup tag
    // geometry_tag: the geometry tag to parse, the parsed setup tag is returned via the same link
    // local_settings: returns the path to the XML file as given (not expanded, e.g. with $VMCWORKDIR), "" if no file
    // return value: 0 - success, < 0 - error codes
    static Int_t ParseGeometryTag(TString& geometry_tag, TString& local_settings);
 
    // get magnetic field value (mV) for the given beam and its energy (e.g. parsed by ParseFileName)
    // beam: beam particle name; energy: beam energy (GeV)
    // return value: magnetic field value (mV), < 0 - in case of errors
    static double GetMagneticFieldByEnergy(const TString& beam, double energy);
 
    // get the correction factor for the magnetic field map scale calculated as 'field voltage / map voltage'
    // energy: beam energy (GeV)
    // return value: correction factor to multiply the field map scale by, 1 - for the energies without correction
    static double GetFieldScaleCorrection(double energy);
 
    static TTimeStamp TimePoint2TS(SysPoint p);
    static SysPoint TimeStamp2TP(TTimeStamp p);
    static void PrintTimePoint(SysPoint p);
    static std::string TimePoint2String(SysPoint p);
    static SysPoint TDatime2GMT(TDatime& tdatime, Int_t timezoneOffsetHours = 0);
 
  private:
    BmnFunctionSet() {}
    ~BmnFunctionSet() {}
 
    static TString JoinKeys(const std::vector<std::pair<TString, TString>>& dict);
    // parsing file name with the given separator (used by ParseFileName)
    // separator: symbol to split the file name into tokens
    // return value: 0 - success, < 0 - error codes
    static Int_t ParseFileNameBySeparator(const TString& file_name,
                                          const TString& separator,
                                          TString& beam,
                                          TString& target,
                                          Double_t& energy);
 
    ClassDef(BmnFunctionSet, 1)
};
 
#endif