fix calculation versus multiplicity
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisGrid.h
CommitLineData
c57f56b7 1#ifndef ALIANALYSISGRID_H
2#define ALIANALYSISGRID_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// AliAnalysisGrid - Base grid utility class. Provides interface for creating
10// a personalized JDL, finding and creating a dataset.
11//==============================================================================
12
13#ifndef ROOT_TNamed
14#include <TNamed.h>
15#endif
16
17class AliAnalysisGrid : public TNamed {
18
19public:
20
21enum EPluginRunMode {
22 kFull = 0,
23 kTest = BIT(14),
24 kOffline = BIT(15),
25 kSubmit = BIT(16),
26 kMerge = BIT(17),
27 kUseTags = BIT(18),
28 kUseESD = BIT(19),
29 kUseAOD = BIT(20),
4e5c5506 30 kUseMC = BIT(21),
bb885a9e 31 kUsePars = BIT(22),
a3e84053 32 kDefaultOutputs = BIT(23)
c57f56b7 33};
348be253 34enum EPluginBits {
35 kBitMask32 = 0xffffffff,
36 kUseCopy = BIT(0),
149d288c 37 kCheckCopy = BIT(1),
38 kKeepLogs = BIT(2)
348be253 39};
c57f56b7 40
348be253 41 AliAnalysisGrid() : TNamed(), fSpecialBits(0) {}
42 AliAnalysisGrid(const char *name) : TNamed(name,""), fSpecialBits(0) {}
c57f56b7 43 virtual ~AliAnalysisGrid() {}
44 AliAnalysisGrid(const AliAnalysisGrid& other);
45 AliAnalysisGrid& operator=(const AliAnalysisGrid& other);
46// Getters
47 virtual EPluginRunMode GetRunMode() const;
48// Setters
f965131e 49 virtual void AddIncludePath(const char *path) = 0;
c57f56b7 50 virtual void AddRunNumber(Int_t run) = 0;
ee75cfc3 51 virtual void AddRunNumber(const char *run) = 0;
c57f56b7 52 virtual void AddDataFile(const char *lfn) = 0;
fe2d7fc2 53 virtual Bool_t IsSingleOutput() const = 0;
c57f56b7 54 virtual void SetExecutable(const char *name="analysis.sh") = 0;
55 virtual void SetArguments(const char *name="") = 0;
56 virtual void SetAnalysisMacro(const char *name="myAnalysis.C") = 0;
57 virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0;
58 virtual void SetAdditionalLibs(const char *list) = 0;
59 virtual void SetPrice(Int_t price=1) = 0;
c6cb3634 60 virtual void SetJobTag(const char *tag="") = 0;
c57f56b7 61 virtual void SetSplitMode(const char *type="se") = 0;
62 virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) = 0;
63 virtual void SetAPIVersion(const char *version) = 0;
64 virtual void SetROOTVersion(const char *version) = 0;
65 virtual void SetAliROOTVersion(const char *version) = 0;
66 virtual void SetUser(const char *user) = 0;
67 virtual void SetTTL(Int_t ttl=30000) = 0;
68 virtual void SetGridWorkingDir(const char *name="workdir") = 0;
69 virtual void SetGridDataDir(const char *name) = 0;
70 virtual void SetDataPattern(const char *pattern) = 0;
bb885a9e 71 virtual void SetDefaultOutputs(Bool_t flag=kTRUE) = 0;
c57f56b7 72 virtual void SetGridOutputDir(const char *name="output") = 0;
149d288c 73 virtual void SetOutputArchive(const char *list="log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2") = 0;
c57f56b7 74 virtual void SetOutputFiles(const char *list) = 0;
75 virtual void SetInputFormat(const char *format="xml-single") = 0;
76 virtual void SetMaxInitFailed(Int_t nfail=5) = 0;
bb885a9e 77 virtual void SetMergeExcludes(const char *list) = 0;
0f389141 78 virtual void SetMergeViaJDL(Bool_t on=kTRUE) = 0;
c57f56b7 79 virtual void SetMasterResubmitThreshold(Int_t percentage) = 0;
bb885a9e 80 virtual void SetNtestFiles(Int_t nfiles) = 0;
c57f56b7 81 virtual void SetJDLName(const char *name="analysis.jdl") = 0;
43da816a 82 virtual void SetPreferedSE(const char *se) = 0;
0f389141 83 virtual void SetProductionMode(Int_t mode=1) = 0;
84 virtual void SetRunPrefix(const char *prefix) = 0;
85 virtual void SetOutputSingleFolder(const char *folder) = 0;
86 virtual void SetFastReadOption(Bool_t on=kTRUE) = 0;
87 virtual void SetOverwriteMode(Bool_t on=kTRUE) = 0;
c57f56b7 88
89 // Set run mode. Can be "full", "test", "offline", "submit" or "merge"
90 virtual void SetRunMode(const char *mode="full");
91//Utilities
92 static Bool_t CreateToken(const char *username=0);
93 virtual Bool_t CreateDataset(const char *pattern) = 0;
94 virtual Bool_t CreateJDL() = 0;
4e5c5506 95 virtual void EnablePackage(const char *package) = 0;
c57f56b7 96 virtual Bool_t MergeOutputs() = 0;
5513444a 97 virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0;
c57f56b7 98 virtual void WriteAnalysisFile() = 0;
99 virtual void WriteAnalysisMacro() = 0;
100 virtual void WriteExecutable() = 0;
0f389141 101 virtual void WriteValidationScript(Bool_t merge=kFALSE) = 0;
c57f56b7 102
348be253 103// Flags
104 Bool_t IsUseCopy() const {return TestSpecialBit(kUseCopy);}
105 void SetUseCopy(Bool_t flag=kTRUE) {SetSpecialBit(kUseCopy,flag);}
106 Bool_t IsCheckCopy() const {return TestSpecialBit(kCheckCopy);}
107 void SetCheckCopy(Bool_t flag=kTRUE) {SetSpecialBit(kCheckCopy,flag);}
149d288c 108 Bool_t IsKeepLogs() const {return TestSpecialBit(kKeepLogs);}
109 void SetKeepLogs(Bool_t flag=kTRUE) {SetSpecialBit(kKeepLogs,flag);}
348be253 110
c57f56b7 111protected:
348be253 112// Methods
c57f56b7 113 virtual Bool_t Connect() = 0;
348be253 114 virtual void SetDefaults() = 0;
115 void SetSpecialBit(UInt_t f) { fSpecialBits |= f & kBitMask32; }
116 void ResetSpecialBit(UInt_t f) { fSpecialBits &= ~(f & kBitMask32); }
117 void SetSpecialBit(UInt_t f, Bool_t set) {(set)?SetSpecialBit(f):ResetSpecialBit(f);}
118 Bool_t TestSpecialBit(UInt_t f) const { return (Bool_t) ((fSpecialBits & f) != 0); }
119 Int_t TestSpecialBits(UInt_t f) const { return (Int_t) (fSpecialBits & f); }
120 void InvertSpecialBit(UInt_t f) { fSpecialBits ^= f & kBitMask32; }
121
122protected:
123 UInt_t fSpecialBits; // special bits
124
125
126 ClassDef(AliAnalysisGrid, 2) // Base class for GRID utilities
c57f56b7 127};
128#endif