UniRun.h

Go to the documentation of this file.

// ----------------------------------------------------------------------
//                    UniRun header file
//                      Generated 05-11-2015
// ----------------------------------------------------------------------
 
/** UniRun.h
 ** Class for the table: run_
 **/
 
#ifndef UniRun_H
#define UniRun_H 1
 
#include "TDatime.h"
#include "TObjArray.h"
#include "TString.h"
#include "UniConnection.h"
#include "UniSearchCondition.h"
#include "uni_db_structures.h"
 
class UniRun
{
  private:
    /* GENERATED PRIVATE MEMBERS (SHOULD NOT BE CHANGED MANUALLY) */
    /// connection to the database
    UniConnection* connectionDB;
 
    /// period number
    int i_period_number;
    /// run number
    int i_run_number;
    /// run type
    int i_run_type;
    /// start datetime
    TDatime ts_start_datetime;
    /// end datetime
    TDatime* ts_end_datetime;
    /// beam particle
    TString str_beam_particle;
    /// target particle
    TString str_target_particle;
    /// energy
    double* d_energy;
    /// field voltage
    double* d_field_voltage;
    /// event count
    int* i_event_count;
    /// run quality
    int i_run_quality;
 
    // Constructor
    UniRun(UniConnection* db_connect,
           int period_number,
           int run_number,
           int run_type,
           TDatime start_datetime,
           TDatime* end_datetime,
           TString beam_particle,
           TString target_particle,
           double* energy,
           double* field_voltage,
           int* event_count,
           int run_quality);
    /* END OF PRIVATE GENERATED PART (SHOULD NOT BE CHANGED MANUALLY) */
 
  public:
    /* GENERATED PUBLIC MEMBERS (SHOULD NOT BE CHANGED MANUALLY) */
    virtual ~UniRun();   // Destructor
 
    // static class functions
    /// add new run to the database
    static UniRun* CreateRun(int period_number,
                             int run_number,
                             int run_type,
                             TDatime start_datetime,
                             TDatime* end_datetime,
                             TString beam_particle,
                             TString target_particle,
                             double* energy,
                             double* field_voltage,
                             int* event_count,
                             int run_quality);
    /// get run from the database
    static UniRun* GetRun(int period_number, int run_number);
    /// check run exists in the database: 1- true, 0 - false, <0 - database operation error
    static int CheckRunExists(int period_number, int run_number);
    /// delete run from the database
    static int DeleteRun(int period_number, int run_number);
    /// print all runs
    static int PrintAll();
 
    // Getters
    /// get period number of the current run
    int GetPeriodNumber() { return i_period_number; }
    /// get run number of the current run
    int GetRunNumber() { return i_run_number; }
    /// get run type of the current run
    int GetRunType() { return i_run_type; }
    /// get start datetime of the current run
    TDatime GetStartDatetime() { return ts_start_datetime; }
    /// get end datetime of the current run
    TDatime* GetEndDatetime()
    {
        if (ts_end_datetime == nullptr)
            return nullptr;
        else
            return new TDatime(*ts_end_datetime);
    }
    /// get beam particle of the current run
    TString GetBeamParticle() { return str_beam_particle; }
    /// get target particle of the current run
    TString GetTargetParticle() { return str_target_particle; }
    /// get energy of the current run
    double* GetEnergy()
    {
        if (d_energy == nullptr)
            return nullptr;
        else
            return new double(*d_energy);
    }
    /// get field voltage of the current run
    double* GetFieldVoltage()
    {
        if (d_field_voltage == nullptr)
            return nullptr;
        else
            return new double(*d_field_voltage);
    }
    /// get event count of the current run
    int* GetEventCount()
    {
        if (i_event_count == nullptr)
            return nullptr;
        else
            return new int(*i_event_count);
    }
    /// get run quality of the current run
    int GetRunQuality() { return i_run_quality; }
 
    // Setters
    /// set period number of the current run
    int SetPeriodNumber(int period_number);
    /// set run number of the current run
    int SetRunNumber(int run_number);
    /// set run type of the current run
    int SetRunType(int run_type);
    /// set start datetime of the current run
    int SetStartDatetime(TDatime start_datetime);
    /// set end datetime of the current run
    int SetEndDatetime(TDatime* end_datetime);
    /// set beam particle of the current run
    int SetBeamParticle(TString beam_particle);
    /// set target particle of the current run
    int SetTargetParticle(TString target_particle);
    /// set energy of the current run
    int SetEnergy(double* energy);
    /// set field voltage of the current run
    int SetFieldVoltage(double* field_voltage);
    /// set event count of the current run
    int SetEventCount(int* event_count);
    /// set run quality of the current run
    int SetRunQuality(int run_quality);
 
    /// print information about current run
    void Print();
    /* END OF PUBLIC GENERATED PART (SHOULD NOT BE CHANGED MANUALLY) */
 
    /// get array of raw files (UniRawFile*) corresponding to the run (return nullptr if an error occured)
    TObjArray* GetRawFiles();
 
    /// get numbers of runs stored in the Database for a selected range
    /// \param[in] start_period start period number for selected run numbers' range
    /// \param[in] start_run start run number for selected run numbers' range (default, 0 means "from the first run of
    /// the start period")
    /// \param[in] end_period end period number for selected run numbers' range (default, -1 means "end_period =
    /// start_period")
    /// \param[in] end_run end run number for selected run numbers' range (default, -1 means "up to the last run of the
    /// end period")
    /// \param[out] run_numbers pairs (period number+run numbers) of existing runs for a selected range (from start to
    /// end)
    /// \return size of 'run_numbers' array. if size < 0, return value corresponds to error number
    static int GetRunNumbers(UniqueRunNumber*& run_numbers,
                             int start_period,
                             int start_run = 0,
                             int end_period = -1,
                             int end_run = -1);
    /// get all numbers of stored runs in the Database
    /// \param[out] run_numbers pairs (period number+run numbers) of all runs
    /// \return size of 'run_numbers' array. if size < 0, return value corresponds to error number
    static int GetRunNumbers(UniqueRunNumber*& run_numbers);
 
    /// get field voltage value
    /// if period_number > 0 and run_number > 0: from the closest previous run, below (period:run)
    /// in another case: for the latest run in the database
    /// ATTENTION: changes the input period and run numbers to the correspoding ones of the previous run with the field
    /// voltage
    static double FindPreviousFieldVoltage(int& period_number, int& run_number);
 
    /// get runs corresponding to the specified single condition and set owner for search_condition to kTRUE
    static TObjArray* Search(UniSearchCondition& search_condition);
    /// get runs corresponding to the specified (vector) conditions and set owner for search_condition to kTRUE
    static TObjArray* Search(TObjArray& search_conditions);
 
    /// get run from the database with the given period and run numbers
    /// if usePrevRunIfMissing is true then find and get the previous (existing) run in case the given run is absent
    /// ATTENTION: changes the input period and run numbers to ones of the found run (if usePrevRunIfMissing is true)
    static UniRun* GetRun(int& period_number, int& run_number, bool usePrevRunIfMissing);
    /// get number of the closest run below the given one
    /// or return the latest run in the database if period_number < 1 or run_number < 1
    static int FindPreviousRun(int& period_number, int& run_number);
 
    ClassDef(UniRun, 1);
};
 
#endif