AliOADBForward.h

Go to the documentation of this file.

// -*- mode: C++ -*-
#ifndef ALIOADBFORWARD_H
#define ALIOADBFORWARD_H
#include <TNamed.h>
#include <TString.h>
#include <TMap.h>
class TFile;
class TTree;
class TBrowser;
class TList;

class AliOADBForward : public TObject
{
public:
  //=== Options ======================================================
  enum ERunSelectMode { 
    kDefault = 0,
    kExact = 1,
    kNewest = 2,
    kNear = 3, 
    kOlder = 4, 
    kNewer = 5
  };
  static const char* Mode2String(ERunSelectMode mode);
  static ERunSelectMode String2Mode(const TString& str);
  static ERunSelectMode Int2Mode(Int_t mode);
  enum { 
    kMaxNearDistance = 1000000,
    kInvalidField    = 999
  };
  //=== Entry ========================================================
  class Entry : public TObject
  {
  public:
    Entry(ULong_t  runNo  = 0, 
    UShort_t sys    = 0, 
    UShort_t sNN    = 0, 
    Short_t  field  = 0, 
    Bool_t   mc     = false, 
    Bool_t   sat    = false,
    TObject* o      = 0);
    Entry(const Entry& o);
    virtual ~Entry() {}
    Entry& operator=(const Entry& o);
    const char* GetTitle() const;
    void Print(Option_t* option="") const; //*MENU*
    ULong_t  fRunNo;           // Run number 
    UShort_t fSys;             // Collision system (1: pp, 2: pbpb, 3: ppb)
    UShort_t fSNN;             // Center of mass energy 
    Short_t  fField;           // L3 magnetic field
    Bool_t   fMC;              // True if only for MC 
    Bool_t   fSatellite;       // Satelitte events
    TObject* fData;            // Correction object
    UInt_t   fTimestamp;       // When the object was stored 
    ULong_t  fAliROOTRevision; // Revision of AliROOT used 
    TString  fAuthor;          // Author of calibration/correction

    ClassDef(Entry,2); // Entry in PWGLF/Forward OADB
  };

  //=== Table ========================================================
  class Table : public TObject
  {
  public:
    Table(TTree* tree, Bool_t isNew, ERunSelectMode mode=kNear);
    Table(const Table& other);
    ~Table();
    Table& operator=(const Table& other);
    void SetVerbose(Bool_t verb=true) { fVerbose = verb; }
    void SetEnableFallBack(Bool_t use=true) { fFallBack = use; }
    // -----------------------------------------------------------------
    const Char_t* GetTableName() const;
    const Char_t* GetName() const;

    // -----------------------------------------------------------------
    Bool_t Update();
    Bool_t Close();
    /* @} */
    // -----------------------------------------------------------------
    Int_t Query(ULong_t        runNo  = 0,
    ERunSelectMode mode   = kNear,
    UShort_t       sys    = 0,
    UShort_t       sNN    = 0, 
    Short_t        fld    = kInvalidField,
    Bool_t         mc     = false,
    Bool_t         sat    = false) const;
    Int_t Query(ULong_t        runNo,
    ERunSelectMode mode,
    const TString& q) const;
    Bool_t Insert(TObject* o, 
      ULong_t  runNo, 
      UShort_t sys, 
      UShort_t sNN, 
      Short_t  field, 
      Bool_t   mc=false, 
      Bool_t   sat=false,
      ULong_t  aliRev=0,
      const TString& author="");
    Int_t GetEntry(ULong_t        run      = 0,
       ERunSelectMode mode     = kNear,
       UShort_t       sys      = 0,
       UShort_t       sNN      = 0, 
       Short_t        fld      = 0,
       Bool_t         mc       = false,
       Bool_t         sat      = false) const;
    Entry* Get(ULong_t        run      = 0,
         ERunSelectMode mode     = kNear,
         UShort_t       sys      = 0,
         UShort_t       sNN      = 0, 
         Short_t        fld      = 0,
         Bool_t         mc       = false,
         Bool_t         sat      = false) const;
    TObject* GetData(ULong_t        run      = 0,
         ERunSelectMode mode     = kNear,
         UShort_t       sys      = 0,
         UShort_t       sNN      = 0, 
         Short_t        fld      = 0,
         Bool_t         mc       = false,
         Bool_t         sat      = false) const;
    /* @} */
    void Print(Option_t* option="") const; //*MENU*
    void Browse(TBrowser* b); 
    Bool_t IsOpen(Bool_t rw=false) const; 

    TTree*         fTree;     // Our tree
    Entry*         fEntry;    // Entry cache 
    Bool_t         fVerbose;  // To be verbose or not 
    ERunSelectMode fMode;     // Run query mode 
    Bool_t         fFallBack; // Enable fall-back

    ClassDef(Table,1); 
  };
  // === Interface ===================================================
  AliOADBForward();
  ~AliOADBForward();
  // --- Open/close/update -------------------------------------------
  Bool_t Open(const TString& fileName, 
        const TString& tables  = "*", 
        Bool_t         rw      = false, 
        Bool_t         verb    = false,
        Bool_t         fallback= false);
  Bool_t Open(TFile*         file,
        const TString& tables, 
        Bool_t         rw      = false, 
        Bool_t         verb    = false,
        Bool_t         fallback= false);
  Bool_t Close();
  Bool_t Update();
  /* @} */
  // --- Queries -----------------------------------------------------
  Entry* Get(const TString& table, 
       ULong_t        run        = 0,
       ERunSelectMode mode       = kNear, 
       UShort_t       sys        = 0,
       UShort_t       sNN        = 0, 
       Short_t        fld        = 0,
       Bool_t         mc         = false,
       Bool_t         sat        = false) const;
  TObject* GetData(const TString& table, 
       ULong_t        run      = 0,
       ERunSelectMode mode     = kNear, 
       UShort_t       sys      = 0,
       UShort_t       sNN      = 0, 
       Short_t        fld      = 0,
       Bool_t         mc       = false,
       Bool_t         sat      = false) const;
  // --- Insert ------------------------------------------------------
  Bool_t Insert(const TString& table, 
    TObject*       o, 
    ULong_t        runNo, 
    UShort_t       sys, 
    UShort_t       sNN, 
    Short_t        field, 
    Bool_t         mc=false, 
    Bool_t         sat=false,
    ULong_t        aliRev=0,
    const TString& author="");
  Bool_t CopyEntry(const TString& table, 
       ULong_t        oldRunNo, 
       UShort_t       oldSys,
       UShort_t       oldSNN, 
       Short_t        oldField, 
       ULong_t        newRunNo,
       UShort_t       newSys,
       UShort_t       newSNN, 
       Short_t        newField, 
       Bool_t         mc, 
       Bool_t         sat);
  /* @} */
  void Print(const Option_t* option="") const; //*MENU*
  void Browse(TBrowser* b); 
  Table* FindTable(const TString& name, Bool_t quite=false) const;
  const TMap& GetTables() const { return fTables; }
protected:
  Int_t GetFiles(TList& files) const;
  Table* GetTableFromFile(TFile* file, Bool_t rw, 
        const TString& name,
        const TString& mode) const;

  void OpenTable(TFile* file, Bool_t rw, const TString& name, 
     const TString& mode, Bool_t verb, Bool_t fallback);
  static void AppendToQuery(TString& q, const TString& s, Bool_t andNotOr=true);
  static TString Conditions(UShort_t       sys    = 0,
          UShort_t       sNN    = 0, 
          Short_t        fld    = kInvalidField,
          Bool_t         mc     = false,
          Bool_t         sat    = false);
  TMap fTables;
  ClassDef(AliOADBForward,0); // PWGLF/Forward OADB interface

public:
  // =================================================================
  static void TestGet(AliOADBForward& t, 
          const TString& table,
          ULong_t  runNo      = 0,
          ERunSelectMode mode = kNear,
          UShort_t sys        = 2,
          UShort_t sNN        = 2760, 
          Short_t  fld        = -5,
          Bool_t   mc         = false,
          Bool_t   sat        = false);
  static void TestInsert(AliOADBForward& t, 
       const TString&  table,
       ULong_t         runNo  = 0,
       UShort_t        sys    = 2,
       UShort_t        sNN    = 2760, 
       Short_t         fld    = -5,
       Bool_t          mc     = false,
       Bool_t          sat    = false);
  static void Test();
  /* @} */
};

#endif
/* Local Variables:
 *  mode: C++
 * End:
 */