Coding conventions...
[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),
30 kUseMC = BIT(21)
31};
32
33 AliAnalysisGrid() {}
34 AliAnalysisGrid(const char *name) : TNamed(name,"") {}
35 virtual ~AliAnalysisGrid() {}
36 AliAnalysisGrid(const AliAnalysisGrid& other);
37 AliAnalysisGrid& operator=(const AliAnalysisGrid& other);
38// Getters
39 virtual EPluginRunMode GetRunMode() const;
40// Setters
41 virtual void AddRunNumber(Int_t run) = 0;
42 virtual void AddDataFile(const char *lfn) = 0;
43 virtual void SetExecutable(const char *name="analysis.sh") = 0;
44 virtual void SetArguments(const char *name="") = 0;
45 virtual void SetAnalysisMacro(const char *name="myAnalysis.C") = 0;
46 virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0;
47 virtual void SetAdditionalLibs(const char *list) = 0;
48 virtual void SetPrice(Int_t price=1) = 0;
49 virtual void SetSplitMode(const char *type="se") = 0;
50 virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) = 0;
51 virtual void SetAPIVersion(const char *version) = 0;
52 virtual void SetROOTVersion(const char *version) = 0;
53 virtual void SetAliROOTVersion(const char *version) = 0;
54 virtual void SetUser(const char *user) = 0;
55 virtual void SetTTL(Int_t ttl=30000) = 0;
56 virtual void SetGridWorkingDir(const char *name="workdir") = 0;
57 virtual void SetGridDataDir(const char *name) = 0;
58 virtual void SetDataPattern(const char *pattern) = 0;
59 virtual void SetGridOutputDir(const char *name="output") = 0;
60 virtual void SetOutputArchive(const char *list="log_archive.zip:stdout,stderr root_archive.zip:*.root") = 0;
61 virtual void SetOutputFiles(const char *list) = 0;
62 virtual void SetInputFormat(const char *format="xml-single") = 0;
63 virtual void SetMaxInitFailed(Int_t nfail=5) = 0;
64 virtual void SetMasterResubmitThreshold(Int_t percentage) = 0;
65 virtual void SetJDLName(const char *name="analysis.jdl") = 0;
66
67 // Set run mode. Can be "full", "test", "offline", "submit" or "merge"
68 virtual void SetRunMode(const char *mode="full");
69//Utilities
70 static Bool_t CreateToken(const char *username=0);
71 virtual Bool_t CreateDataset(const char *pattern) = 0;
72 virtual Bool_t CreateJDL() = 0;
73 virtual Bool_t MergeOutputs() = 0;
74 virtual void StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0;
75 virtual void WriteAnalysisFile() = 0;
76 virtual void WriteAnalysisMacro() = 0;
77 virtual void WriteExecutable() = 0;
78 virtual void WriteValidationScript() = 0;
79
80protected:
81 virtual Bool_t Connect() = 0;
82 virtual void SetDefaults() = 0;
83 ClassDef(AliAnalysisGrid, 1) // Base class for GRID utilities
84};
85#endif