- New methods added to AliAnalysisAlien:
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisAlien.h
1 #ifndef ALIANALYSISALIEN_H
2 #define ALIANALYSISALIEN_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 // Author: Mihaela Gheata, 01/09/2008
7
8 //==============================================================================
9 //   AliAnalysisAlien - AliEn utility class. Provides interface for creating
10 // a personalized JDL, finding and creating a dataset.
11 //==============================================================================
12
13 #ifndef ALIANALYSISGRID_H
14 #include "AliAnalysisGrid.h"
15 #endif
16
17 #ifndef ROOT_TString
18 #include <TString.h>
19 #endif
20
21 class TGridJDL;
22
23 class AliAnalysisAlien : public AliAnalysisGrid {
24
25 public:
26
27    AliAnalysisAlien();
28    AliAnalysisAlien(const char *name);
29    virtual ~AliAnalysisAlien();
30    AliAnalysisAlien(const AliAnalysisAlien& other); 
31    AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
32 // Setters   
33    virtual void        AddRunNumber(Int_t run);
34    virtual void        AddDataFile(const char *lfn);
35    virtual void        SetExecutable(const char *name="analysis.sh")     {fExecutable = name;}
36    virtual void        SetArguments(const char *name="")                 {fArguments = name;}
37    virtual void        SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
38    virtual void        SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
39    virtual void        SetAdditionalLibs(const char *list)               {fAdditionalLibs = list;}
40    virtual void        SetPrice(Int_t price=1)                           {fPrice = price;}
41    virtual void        SetSplitMode(const char *type="se")               {fSplitMode = type;}
42    virtual void        SetSplitMaxInputFileNumber(Int_t nfiles=100)      {fSplitMaxInputFileNumber = nfiles;}
43    virtual void        SetAPIVersion(const char *version="V2.4") {fAPIVersion = version;}
44    virtual void        SetROOTVersion(const char *version="v5-21-01-alice") {fROOTVersion = version;}
45    virtual void        SetAliROOTVersion(const char *version="v4-14-Rev-02") {fAliROOTVersion=version;}
46    virtual void        SetUser(const char *user)                         {fUser = user;}
47    virtual void        SetTTL(Int_t ttl=30000)                           {fTTL = ttl;}
48    virtual void        SetGridWorkingDir(const char *name="workdir")     {fGridWorkingDir = name;}
49    virtual void        SetGridDataDir(const char *name)                  {fGridDataDir = name;}
50    virtual void        SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
51    virtual void        SetDefaultOutputs(Bool_t flag);
52    virtual void        SetGridOutputDir(const char *name="output")       {fGridOutputDir = name;}
53    virtual void        SetOutputArchive(const char *list="log_archive.zip:stdout,stderr root_archive.zip:*.root") {fOutputArchive = list;}
54    virtual void        SetOutputFiles(const char *list)                  {fOutputFiles = list;}
55    virtual void        SetInputFormat(const char *format="xml-single")   {fInputFormat = format;}
56    virtual void        SetMaxInitFailed(Int_t nfail=5)                   {fMaxInitFailed = nfail;}
57    virtual void        SetMergeExcludes(const char *list)                {fMergeExcludes = list;};
58    virtual void        SetMasterResubmitThreshold(Int_t percentage)      {fMasterResubmitThreshold = percentage;}
59    virtual void        SetNtestFiles(Int_t nfiles)                       {fNtestFiles = nfiles;}
60    virtual void        SetJDLName(const char *name="analysis.jdl")       {fJDLName = name;}
61
62    TGridJDL           *GetGridJDL() {return fGridJDL;}
63 //Utilities
64    virtual Bool_t      CreateDataset(const char *pattern);
65    virtual Bool_t      CreateJDL();
66    virtual void        EnablePackage(const char *package);
67    virtual Bool_t      MergeOutputs();
68    virtual void        StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
69    virtual void        WriteAnalysisFile();
70    virtual void        WriteAnalysisMacro();
71    virtual void        WriteExecutable();
72    virtual void        WriteValidationScript();
73
74 protected:
75    void                CdWork();
76    Bool_t              CheckInputData();
77    void                CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
78    virtual Bool_t      Connect();
79    virtual void        SetDefaults();  
80
81    Bool_t              FileExists(const char *lfn) const;
82    Bool_t              IsCollection(const char *lfn) const;
83    Bool_t              IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
84
85 private:
86    TGridJDL        *fGridJDL;         //! JDL maker
87    Int_t            fPrice;           // Grid price for the job;
88    Int_t            fTTL;             // Time to live.
89    Int_t            fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
90    Int_t            fMaxInitFailed;   // Maximum initial consecutive subjobs accepted to fail
91    Int_t            fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
92    Int_t            fNtestFiles;      // Number of files used in the testing case
93    TString          fRunNumbers;      // List of runs to be processed
94    TString          fExecutable;      // Executable script for AliEn job
95    TString          fArguments;       // Arguments for the executable script
96    TString          fAnalysisMacro;   // Root macro steering the analysis
97    TString          fAnalysisSource;  // User analysis implementation (.cxx) file(s)
98    TString          fAdditionalLibs;  // List (separated by blacs) of additional libraries needed for the analysis
99    TString          fSplitMode;       // Job split mode
100    TString          fAPIVersion;      // API version
101    TString          fROOTVersion;     // ROOT version
102    TString          fAliROOTVersion;  // AliROOT version
103    TString          fUser;            // AliEn user name
104    TString          fGridWorkingDir;  // AliEn directory containing the input packages
105    TString          fGridDataDir;     // AliEn data production directory
106    TString          fDataPattern;     // Data pattern for 'find' command
107    TString          fGridOutputDir;   // AliEn directory (wrt work dir) where the output should be written
108    TString          fOutputArchive;   // List of output archives separated by blancs
109    TString          fOutputFiles;     // List of output files separated by blancs
110    TString          fInputFormat;     // Input format (xml-single)
111    TString          fDatasetName;     // Dataset xml file to be created
112    TString          fJDLName;         // JDL file to be generated
113    TString          fMergeExcludes;   // List of output files excluded from merging
114    TString          fCloseSE;         // Preffered storage element. Taken from alien_CLOSE_SE environment.
115    TObjArray       *fInputFiles;      // List of input files to be processed by the job
116    TObjArray       *fPackages;        // List of packages to be used
117    
118    ClassDef(AliAnalysisAlien, 2)   // Class providing some AliEn utilities
119 };
120 #endif