Fix coding violations
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisAlien.h
CommitLineData
c57f56b7 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
21class TGridJDL;
22
23class AliAnalysisAlien : public AliAnalysisGrid {
24
25public:
26
27 AliAnalysisAlien();
28 AliAnalysisAlien(const char *name);
29 virtual ~AliAnalysisAlien();
30 AliAnalysisAlien(const AliAnalysisAlien& other);
31 AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
32// Setters
f965131e 33 virtual void AddIncludePath(const char *path);
c57f56b7 34 virtual void AddRunNumber(Int_t run);
ee75cfc3 35 virtual void AddRunNumber(const char *run);
c57f56b7 36 virtual void AddDataFile(const char *lfn);
37 virtual void SetExecutable(const char *name="analysis.sh") {fExecutable = name;}
38 virtual void SetArguments(const char *name="") {fArguments = name;}
39 virtual void SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
40 virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
41 virtual void SetAdditionalLibs(const char *list) {fAdditionalLibs = list;}
42 virtual void SetPrice(Int_t price=1) {fPrice = price;}
a8739e8a 43 virtual void SetRunRange(Int_t min, Int_t max) {fRunRange[0] = min; fRunRange[1] = max;}
c6cb3634 44 virtual void SetJobTag(const char *tag="") {fJobTag = tag;}
319593fb 45 virtual void SetNrunsPerMaster(Int_t nruns=1) {fNrunsPerMaster = nruns;}
16a4353c 46 virtual void SetMaxMergeFiles(Int_t nfiles) {fMaxMergeFiles = nfiles;}
c57f56b7 47 virtual void SetSplitMode(const char *type="se") {fSplitMode = type;}
48 virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) {fSplitMaxInputFileNumber = nfiles;}
49 virtual void SetAPIVersion(const char *version="V2.4") {fAPIVersion = version;}
50 virtual void SetROOTVersion(const char *version="v5-21-01-alice") {fROOTVersion = version;}
51 virtual void SetAliROOTVersion(const char *version="v4-14-Rev-02") {fAliROOTVersion=version;}
52 virtual void SetUser(const char *user) {fUser = user;}
53 virtual void SetTTL(Int_t ttl=30000) {fTTL = ttl;}
54 virtual void SetGridWorkingDir(const char *name="workdir") {fGridWorkingDir = name;}
55 virtual void SetGridDataDir(const char *name) {fGridDataDir = name;}
56 virtual void SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
0df6ccf2 57 virtual void SetFriendChainName(const char *name="") {fFriendChainName = name;}
bb885a9e 58 virtual void SetDefaultOutputs(Bool_t flag);
c57f56b7 59 virtual void SetGridOutputDir(const char *name="output") {fGridOutputDir = name;}
60 virtual void SetOutputArchive(const char *list="log_archive.zip:stdout,stderr root_archive.zip:*.root") {fOutputArchive = list;}
61 virtual void SetOutputFiles(const char *list) {fOutputFiles = list;}
62 virtual void SetInputFormat(const char *format="xml-single") {fInputFormat = format;}
63 virtual void SetMaxInitFailed(Int_t nfail=5) {fMaxInitFailed = nfail;}
bb885a9e 64 virtual void SetMergeExcludes(const char *list) {fMergeExcludes = list;};
c57f56b7 65 virtual void SetMasterResubmitThreshold(Int_t percentage) {fMasterResubmitThreshold = percentage;}
bb885a9e 66 virtual void SetNtestFiles(Int_t nfiles) {fNtestFiles = nfiles;}
c57f56b7 67 virtual void SetJDLName(const char *name="analysis.jdl") {fJDLName = name;}
43da816a 68 virtual void SetPreferedSE(const char *se) {fCloseSE = se;}
a3e84053 69 virtual void SetProductionMode(Int_t mode=1) {fProductionMode = mode;}
c57f56b7 70
71 TGridJDL *GetGridJDL() {return fGridJDL;}
5513444a 72 const char *GetGridOutputDir() const {return fGridOutputDir;}
c57f56b7 73//Utilities
74 virtual Bool_t CreateDataset(const char *pattern);
75 virtual Bool_t CreateJDL();
4e5c5506 76 virtual void EnablePackage(const char *package);
923e2ca5 77 static Bool_t DirectoryExists(const char *lfn);
5513444a 78 static Bool_t FileExists(const char *lfn);
d2a409b2 79 static const char *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
c57f56b7 80 virtual Bool_t MergeOutputs();
16a4353c 81 virtual void Print(Option_t *option="") const;
5513444a 82 virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
d2a409b2 83 virtual void Submit();
c57f56b7 84 virtual void WriteAnalysisFile();
85 virtual void WriteAnalysisMacro();
86 virtual void WriteExecutable();
5513444a 87 virtual Bool_t WriteJDL(Bool_t copy);
88 virtual void WriteProductionFile(const char *filename) const;
c57f56b7 89 virtual void WriteValidationScript();
90
91protected:
92 void CdWork();
93 Bool_t CheckInputData();
94 void CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
95 virtual Bool_t Connect();
96 virtual void SetDefaults();
d2a409b2 97 void SubmitNext();
c57f56b7 98
c57f56b7 99 Bool_t IsCollection(const char *lfn) const;
100 Bool_t IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
101
102private:
103 TGridJDL *fGridJDL; //! JDL maker
104 Int_t fPrice; // Grid price for the job;
105 Int_t fTTL; // Time to live.
106 Int_t fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
107 Int_t fMaxInitFailed; // Maximum initial consecutive subjobs accepted to fail
108 Int_t fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
bb885a9e 109 Int_t fNtestFiles; // Number of files used in the testing case
a8739e8a 110 Int_t fRunRange[2]; // Run range
319593fb 111 Int_t fNrunsPerMaster; // Number of runs per masterjob
16a4353c 112 Int_t fMaxMergeFiles; // Maximum number of files to be merged in one chunk
d2a409b2 113 Int_t fNsubmitted; // Number of jobs submitted
a3e84053 114 Int_t fProductionMode; // Production mode (0-off, 1-on)
c57f56b7 115 TString fRunNumbers; // List of runs to be processed
116 TString fExecutable; // Executable script for AliEn job
117 TString fArguments; // Arguments for the executable script
118 TString fAnalysisMacro; // Root macro steering the analysis
119 TString fAnalysisSource; // User analysis implementation (.cxx) file(s)
120 TString fAdditionalLibs; // List (separated by blacs) of additional libraries needed for the analysis
121 TString fSplitMode; // Job split mode
122 TString fAPIVersion; // API version
123 TString fROOTVersion; // ROOT version
124 TString fAliROOTVersion; // AliROOT version
125 TString fUser; // AliEn user name
126 TString fGridWorkingDir; // AliEn directory containing the input packages
127 TString fGridDataDir; // AliEn data production directory
128 TString fDataPattern; // Data pattern for 'find' command
129 TString fGridOutputDir; // AliEn directory (wrt work dir) where the output should be written
130 TString fOutputArchive; // List of output archives separated by blancs
131 TString fOutputFiles; // List of output files separated by blancs
132 TString fInputFormat; // Input format (xml-single)
133 TString fDatasetName; // Dataset xml file to be created
134 TString fJDLName; // JDL file to be generated
bb885a9e 135 TString fMergeExcludes; // List of output files excluded from merging
f965131e 136 TString fIncludePath; // Include path
bb885a9e 137 TString fCloseSE; // Preffered storage element. Taken from alien_CLOSE_SE environment.
0df6ccf2 138 TString fFriendChainName; // File name to construct friend chain (for AOD)
c6cb3634 139 TString fJobTag; // Job tag
c57f56b7 140 TObjArray *fInputFiles; // List of input files to be processed by the job
4e5c5506 141 TObjArray *fPackages; // List of packages to be used
c57f56b7 142
a3e84053 143 ClassDef(AliAnalysisAlien, 6) // Class providing some AliEn utilities
c57f56b7 144};
145#endif