[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisGrid.h

#ifndef ALIANALYSISGRID_H
#define ALIANALYSISGRID_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

// Author: Mihaela Gheata, 01/09/2008

//==============================================================================
//   AliAnalysisGrid - Base grid utility class. Provides interface for creating
// a personalized JDL, finding and creating a dataset.
//==============================================================================

#ifndef ROOT_TNamed
#include <TNamed.h>
#endif

class AliAnalysisGrid : public TNamed {

public:

enum EPluginRunMode {
   kFull     = 0,
   kTest     = BIT(14),
   kOffline  = BIT(15),
   kSubmit   = BIT(16),
   kMerge    = BIT(17),
   kUseTags  = BIT(18),
   kUseESD   = BIT(19),
   kUseAOD   = BIT(20),
   kUseMC    = BIT(21),
   kUsePars  = BIT(22),
   kDefaultOutputs = BIT(23)
};   

   AliAnalysisGrid() {}
   AliAnalysisGrid(const char *name) : TNamed(name,"") {}
   virtual ~AliAnalysisGrid() {}
   AliAnalysisGrid(const AliAnalysisGrid& other); 
   AliAnalysisGrid& operator=(const AliAnalysisGrid& other);
// Getters
   virtual EPluginRunMode GetRunMode() const;
// Setters   
   virtual void        AddIncludePath(const char *path)                  = 0;
   virtual void        AddRunNumber(Int_t run)                           = 0;
   virtual void        AddRunNumber(const char *run)                     = 0;
   virtual void        AddDataFile(const char *lfn)                      = 0;
   virtual Bool_t      IsSingleOutput() const                            = 0;
   virtual void        SetExecutable(const char *name="analysis.sh")     = 0;
   virtual void        SetArguments(const char *name="")                 = 0;
   virtual void        SetAnalysisMacro(const char *name="myAnalysis.C") = 0;
   virtual void        SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0;
   virtual void        SetAdditionalLibs(const char *list)               = 0;
   virtual void        SetPrice(Int_t price=1)                           = 0;
   virtual void        SetJobTag(const char *tag="")                     = 0;
   virtual void        SetSplitMode(const char *type="se")               = 0;
   virtual void        SetSplitMaxInputFileNumber(Int_t nfiles=100)      = 0;
   virtual void        SetAPIVersion(const char *version)                = 0;
   virtual void        SetROOTVersion(const char *version)               = 0;
   virtual void        SetAliROOTVersion(const char *version)            = 0;
   virtual void        SetUser(const char *user)                         = 0;
   virtual void        SetTTL(Int_t ttl=30000)                           = 0;
   virtual void        SetGridWorkingDir(const char *name="workdir")     = 0;
   virtual void        SetGridDataDir(const char *name)                  = 0;
   virtual void        SetDataPattern(const char *pattern)               = 0;
   virtual void        SetDefaultOutputs(Bool_t flag=kTRUE)              = 0;
   virtual void        SetGridOutputDir(const char *name="output")       = 0;
   virtual void        SetOutputArchive(const char *list="log_archive.zip:stdout,stderr root_archive.zip:*.root") = 0;
   virtual void        SetOutputFiles(const char *list)                  = 0;
   virtual void        SetInputFormat(const char *format="xml-single")   = 0;
   virtual void        SetMaxInitFailed(Int_t nfail=5)                   = 0;
   virtual void        SetMergeExcludes(const char *list)                = 0;
   virtual void        SetMergeViaJDL(Bool_t on=kTRUE)                   = 0;
   virtual void        SetMasterResubmitThreshold(Int_t percentage)      = 0;
   virtual void        SetNtestFiles(Int_t nfiles)                       = 0;
   virtual void        SetJDLName(const char *name="analysis.jdl")       = 0;
   virtual void        SetPreferedSE(const char *se)                     = 0;
   virtual void        SetProductionMode(Int_t mode=1)                   = 0;
   virtual void        SetRunPrefix(const char *prefix)                  = 0;
   virtual void        SetOutputSingleFolder(const char *folder)         = 0;
   virtual void        SetFastReadOption(Bool_t on=kTRUE)                = 0;
   virtual void        SetOverwriteMode(Bool_t on=kTRUE)                 = 0;
   
 // Set run mode.  Can be "full", "test", "offline", "submit" or "merge"
   virtual void        SetRunMode(const char *mode="full");
//Utilities
   static  Bool_t      CreateToken(const char *username=0);
   virtual Bool_t      CreateDataset(const char *pattern)                = 0;
   virtual Bool_t      CreateJDL()                                       = 0;
   virtual void        EnablePackage(const char *package)                = 0;
   virtual Bool_t      MergeOutputs()                                    = 0;
   virtual Bool_t      StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0;
   virtual void        WriteAnalysisFile()                               = 0;
   virtual void        WriteAnalysisMacro()                              = 0;
   virtual void        WriteExecutable()                                 = 0;
   virtual void        WriteValidationScript(Bool_t merge=kFALSE)        = 0;

protected:
   virtual Bool_t      Connect()                                         = 0;
   virtual void        SetDefaults()                                     = 0;   
   ClassDef(AliAnalysisGrid, 1)   // Base class for GRID utilities
};
#endif
Commit	Line	Data
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
	17	class AliAnalysisGrid : public TNamed {
	18
	19	public:
	20
	21	enum 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	};
	34
	35	AliAnalysisGrid() {}
	36	AliAnalysisGrid(const char *name) : TNamed(name,"") {}
	37	virtual ~AliAnalysisGrid() {}
	38	AliAnalysisGrid(const AliAnalysisGrid& other);
	39	AliAnalysisGrid& operator=(const AliAnalysisGrid& other);
	40	// Getters
	41	virtual EPluginRunMode GetRunMode() const;
	42	// Setters
f965131e	43	virtual void AddIncludePath(const char *path) = 0;
c57f56b7	44	virtual void AddRunNumber(Int_t run) = 0;
ee75cfc3	45	virtual void AddRunNumber(const char *run) = 0;
c57f56b7	46	virtual void AddDataFile(const char *lfn) = 0;
fe2d7fc2	47	virtual Bool_t IsSingleOutput() const = 0;
c57f56b7	48	virtual void SetExecutable(const char *name="analysis.sh") = 0;
	49	virtual void SetArguments(const char *name="") = 0;
	50	virtual void SetAnalysisMacro(const char *name="myAnalysis.C") = 0;
	51	virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0;
	52	virtual void SetAdditionalLibs(const char *list) = 0;
	53	virtual void SetPrice(Int_t price=1) = 0;
c6cb3634	54	virtual void SetJobTag(const char *tag="") = 0;
c57f56b7	55	virtual void SetSplitMode(const char *type="se") = 0;
	56	virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) = 0;
	57	virtual void SetAPIVersion(const char *version) = 0;
	58	virtual void SetROOTVersion(const char *version) = 0;
	59	virtual void SetAliROOTVersion(const char *version) = 0;
	60	virtual void SetUser(const char *user) = 0;
	61	virtual void SetTTL(Int_t ttl=30000) = 0;
	62	virtual void SetGridWorkingDir(const char *name="workdir") = 0;
	63	virtual void SetGridDataDir(const char *name) = 0;
	64	virtual void SetDataPattern(const char *pattern) = 0;
bb885a9e	65	virtual void SetDefaultOutputs(Bool_t flag=kTRUE) = 0;
c57f56b7	66	virtual void SetGridOutputDir(const char *name="output") = 0;
	67	virtual void SetOutputArchive(const char list="log_archive.zip:stdout,stderr root_archive.zip:.root") = 0;
	68	virtual void SetOutputFiles(const char *list) = 0;
	69	virtual void SetInputFormat(const char *format="xml-single") = 0;
	70	virtual void SetMaxInitFailed(Int_t nfail=5) = 0;
bb885a9e	71	virtual void SetMergeExcludes(const char *list) = 0;
0f389141	72	virtual void SetMergeViaJDL(Bool_t on=kTRUE) = 0;
c57f56b7	73	virtual void SetMasterResubmitThreshold(Int_t percentage) = 0;
bb885a9e	74	virtual void SetNtestFiles(Int_t nfiles) = 0;
c57f56b7	75	virtual void SetJDLName(const char *name="analysis.jdl") = 0;
43da816a	76	virtual void SetPreferedSE(const char *se) = 0;
0f389141	77	virtual void SetProductionMode(Int_t mode=1) = 0;
	78	virtual void SetRunPrefix(const char *prefix) = 0;
	79	virtual void SetOutputSingleFolder(const char *folder) = 0;
	80	virtual void SetFastReadOption(Bool_t on=kTRUE) = 0;
	81	virtual void SetOverwriteMode(Bool_t on=kTRUE) = 0;
c57f56b7	82
	83	// Set run mode. Can be "full", "test", "offline", "submit" or "merge"
	84	virtual void SetRunMode(const char *mode="full");
	85	//Utilities
	86	static Bool_t CreateToken(const char *username=0);
	87	virtual Bool_t CreateDataset(const char *pattern) = 0;
	88	virtual Bool_t CreateJDL() = 0;
4e5c5506	89	virtual void EnablePackage(const char *package) = 0;
c57f56b7	90	virtual Bool_t MergeOutputs() = 0;
5513444a	91	virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0;
c57f56b7	92	virtual void WriteAnalysisFile() = 0;
	93	virtual void WriteAnalysisMacro() = 0;
	94	virtual void WriteExecutable() = 0;
0f389141	95	virtual void WriteValidationScript(Bool_t merge=kFALSE) = 0;
c57f56b7	96
	97	protected:
	98	virtual Bool_t Connect() = 0;
	99	virtual void SetDefaults() = 0;
	100	ClassDef(AliAnalysisGrid, 1) // Base class for GRID utilities
	101	};
	102	#endif