KVDataAnalyser.h

/*
$Id: KVDataAnalyser.h,v 1.18 2009/04/01 09:28:34 franklan Exp $
$Revision: 1.18 $
$Date: 2009/04/01 09:28:34 $
$Author: franklan $
*/
 
#ifndef __KVDATAANALYSER_H
#define __KVDATAANALYSER_H
 
#include "TObject.h"
#include "TTree.h"
#include "KVList.h"
#include "KVBatchSystem.h"
#include "KVString.h"
#include "KVNumberList.h"
#include "TEnv.h"
#include "KV2Body.h"
#include "KVUnownedList.h"
class KVDBRun;
class KVDBRunFile;
class KVDBSystem;
class KVDataAnalysisTask;
 
class KVDataAnalyser : public TObject {
 
public:
   struct UserClass {
      KVString name;       // the name of the class
      KVString imp_file;   // the name of the implementation file
      KVString dec_file;   // the name of the header file
      KVString dir_name = "$(PWD)"; // the name of the directory containing the files
 
      /* N.B.: TSystem::ExpandPathName does not expand ".", this is why we use "$(PWD)" */
 
      KVString get_full_path(const KVString&, const KVString& = "") const;
      KVString full_path_imp(const KVString& other_dir = "") const
      {
         return get_full_path(imp_file, other_dir);
      }
      KVString full_path_dec(const KVString& other_dir = "") const
      {
         return get_full_path(dec_file, other_dir);
      }
      Bool_t with_files() const
      {
         return !imp_file.IsNull() && !dec_file.IsNull();
      }
      void reset()
      {
         name = imp_file = dec_file = "";
         dir_name = "$(PWD)";
      }
   };
 
private:
    KVDataAnalysisTask* fTask;
    KVString fDataType;
    Bool_t fBatch;
    KVString fBatchName;
   Long64_t nbEventToRead;
 
    Bool_t fMenus;
    Bool_t fQuit;
    Bool_t fSubmit;
 
    KVString fIncludes;
    KVString fLibraries;
    UserClass fUserClass;
    Bool_t fUserClassIsOK;
    KVString fUserClassOptions;
    KVString fUserClassAlternativeBaseClass;
 
    KVDataAnalyser* fParent;
 
    std::unique_ptr<TEnv> fBatchEnv;
    KVBatchSystem* fBatchSystem;
    Bool_t fChoseRunMode;
 
    TList* fWorkDirEnd;
    static Bool_t fCleanAbort;
   Bool_t fUseBaseClassSubmitTask;
 
   Double_t fStatusUpdateInterval;
 
protected:
    TList* fWorkDirInit;
   void ScanWorkingDirectory(TList**);
   void CopyAnalysisResultsToLaunchDirectory();
 
   virtual Bool_t CheckIfUserClassIsValid(const KVString& alternative_base_class = "");
   TObject* GetInstanceOfUserClass(const KVString& alternative_base_class = "");
 
   const Char_t* GetACliCMode();
 
   void OpenBatchInfoFile(const TString& filename)
   {
 
      if (!fBatchEnv || filename != fBatchEnv->GetRcName()) {
         fBatchEnv.reset(new TEnv(filename));
      }
   }
   TEnv* GetBatchInfoFile() const
   {
      return fBatchEnv.get();
   }
   virtual Bool_t PreSubmitCheck()
   {
      return kTRUE;
   }
   virtual void PostRunReset();
   virtual Bool_t NeedToChooseWhatToDo() const
   {
      return !GetAnalysisTask();
   }
   virtual Bool_t NeedToChooseWhatToAnalyse() const
   {
      AbstractMethod("NeedToChooseWhatToAnalyse");
      return kTRUE;
   }
   virtual void ChooseWhatToAnalyse()
   {
   }
   virtual void ChooseWhatToDo()
   {
   }
   virtual Bool_t CheckWhatToAnalyseAndHow();
 
   virtual void set_up_analyser_for_task(KVDataAnalyser* the_analyser);
 
public:
   enum EProofMode {
      None,
      Lite,
      Proof
   };
private:
   EProofMode fProofMode;
public:
   void SetProofMode(EProofMode e)
   {
      fProofMode = e;
   }
   EProofMode GetProofMode() const
   {
      return fProofMode;
   }
 
   static void SetAbortProcessingLoop(Bool_t now = kTRUE)
   {
      fCleanAbort = now;
   }
   static Bool_t AbortProcessingLoop()
   {
      return fCleanAbort;
   }
 
   KVDataAnalyser();
   virtual ~KVDataAnalyser();
 
   void SetUserClass(const UserClass& kvs, Bool_t check = kTRUE);
   KVString GetUserClassName()
   {
      return fUserClass.name;
   }
   const UserClass& GetUserClass() const
   {
      return fUserClass;
   }
   Bool_t IsUserClassValid() const
   {
      return fUserClassIsOK;
   }
 
   virtual Int_t GetNumberOfFilesToAnalyse() const
   {
      return 0;
   }
 
   virtual void Run();
   virtual void RunMenus();
   void ChooseUserClass();
   void ChooseRunningMode();
   virtual void SubmitTask();
   virtual Bool_t CheckTaskVariables();
   Bool_t DoUserClassFilesExist();
 
   void SetBatchMode(Bool_t on = kTRUE)
   {
      fBatch = on;
   }
   Bool_t BatchMode() const
   {
      return fBatch;
   }
   void SetBatchName(const Char_t* batchname)
   {
      fBatchName = batchname;
   }
   const Char_t* GetBatchName()
   {
      return fBatchName.Data();
   }
   void SetBatchSystem(KVBatchSystem* bs)
   {
      fBatchSystem = bs;
      fChoseRunMode = kTRUE;
      if (bs) fBatchSystem->cd();
   }
   virtual const KVBatchSystem* GetBatchSystem()
   {
      return fBatchSystem;
   }
   Bool_t RunningInLaunchDirectory();
 
   const Char_t* GetLaunchDirectory() const;
   TString GetPathToFileInLaunchDirectory(const TString&) const;
   const Char_t* GetBatchStatusFileName() const;
   void UpdateBatchStatusFile(Int_t totev, Int_t evread, TString disk) const;
   void DeleteBatchStatusFile() const;
   virtual Long64_t GetTotalEntriesToRead() const
   {
      return 0;
   }
   virtual Bool_t CheckStatusUpdateInterval(Long64_t nevents) const;
   void SetStatusUpdateInterval(double t)
   {
      fStatusUpdateInterval = t;
   }
   Double_t GetStatusUpdateInterval() const
   {
      return fStatusUpdateInterval;
   }
 
   void DoStatusUpdate(Long64_t nevents) const;
 
   KVDataAnalysisTask* GetAnalysisTask() const
   {
      return fTask;
   }
   const KVString& GetDataType() const
   {
      return fDataType;
   }
   const KVString& GetUserIncludes() const
   {
      return fIncludes;
   }
   const KVString& GetUserLibraries() const
   {
      return fLibraries;
   }
   virtual void SetFileList(const KVUnownedList&)
   {
      AbstractMethod("SetFileList(KVUnownedList&)");
   }
   virtual void SetAuxFileList(const KVUnownedList&)
   {
      AbstractMethod("SetAuxFileList(const KVUnownedList&))");
   }
 
   void SetNbEventToRead(Long64_t nb = 0)
   {
      Info("SetNbEventToRead", "called with %lld", nb);
      nbEventToRead = nb;
   }
 
   Long64_t GetNbEventToRead(void) const
   {
      return nbEventToRead;
   }
 
   void ChooseNbEventToRead();
   void SetAnalysisTask(KVDataAnalysisTask* at);
   void SetDataType(const Char_t* name)
   {
      fDataType = name;
   }
 
   void SetUserIncludes(const Char_t* incDirs = 0);
   void SetUserLibraries(const Char_t* libs = 0);
 
   virtual void Reset();
 
   void SetParent(KVDataAnalyser* da)
   {
      fParent = da;
   }
   KVDataAnalyser* GetParent() const
   {
      return fParent;
   }
 
   static KVDataAnalyser* GetAnalyser(const Char_t* plugin);
   virtual Bool_t ReadBatchEnvFile(const TString&);
   virtual void WriteBatchEnvFile(const TString&, Bool_t sav = kTRUE);
 
   virtual TString ExpandAutoBatchName(const Char_t* format) const;
 
   /* methods which can be used to customise analysis class behaviour.
      they can be called from the analysis class using the global
      pointer to the current data analyser, gDataAnalyser  */
   virtual void preInitAnalysis() {}
   virtual void postInitAnalysis() {}
   virtual void preInitRun() {}
   virtual void postInitRun() {}
   virtual void preAnalysis() {}
   virtual void postAnalysis() {}
   virtual void preEndRun() {}
   virtual void postEndRun() {}
   virtual void preEndAnalysis() {}
   virtual void postEndAnalysis() {}
 
   void WriteBatchInfo(TTree*);
 
   virtual void RegisterUserClass(TObject*) {}
 
   void SetUserClassOptions(const Char_t* o = "")
   {
      fUserClassOptions = o;
   }
   const KVString& GetUserClassOptions() const
   {
      return fUserClassOptions;
   }
 
   static void RunAnalyser(const Char_t* plugin = "");
 
   static Bool_t IsRunningBatchAnalysis();
 
   virtual void AddJobDescriptionList(TList*);
 
   void SetMenus(Bool_t on = kTRUE)
   {
      fMenus = on;
   }
   Bool_t IsMenus() const
   {
      return fMenus;
   }
   void SetQuit(Bool_t yes = kTRUE)
   {
      fQuit = yes;
   }
   Bool_t IsQuit() const
   {
      return fQuit;
   }
   void SetSubmit(Bool_t yes = kTRUE)
   {
      fSubmit = yes;
   }
   Bool_t IsSubmit() const
   {
      return fSubmit;
   }
   virtual KVString GetRootDirectoryOfDataToAnalyse() const
   {
      AbstractMethod("GetRootDirectoryOfDataToAnalyse");
      return "";
   }
   virtual const Char_t* GetRecognisedAutoBatchNameKeywords() const;
   void UseBaseClassSubmitTask()
   {
      fUseBaseClassSubmitTask = kTRUE;
   }
   virtual const KV2Body* GetKinematics() const
   {
      return nullptr;
   }
   virtual KVDBSystem* GetAnalysedSystem() const
   {
      return nullptr;
   }
   virtual KVDBRun* GetAnalysedRun() const
   {
      return nullptr;
   }
   virtual KVDBRunFile* GetAnalysedRunFile() const
   {
      return nullptr;
   }
   virtual void SetTriggerConditionsForRun(int) {}
 
   virtual void SetAnalysedTree(TTree*) {}
   virtual TTree* GetAnalysedTree() const
   {
 
      return nullptr;
   }
   virtual TString GetAnalyserClassNameForBatchJob()
   {
      return "";
   }
 
   ClassDef(KVDataAnalyser, 0)  //For submitting & performing data analysis tasks
};
 
R__EXTERN KVDataAnalyser* gDataAnalyser;
 
#endif