[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 TChain;

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)
};   
enum EPluginBits {
   kBitMask32  = 0xffffffff,
   kUseCopy    = BIT(0),
   kCheckCopy  = BIT(1),
   kKeepLogs   = BIT(2),
   kClearPackages = BIT(3),
   kUseSubmitPolicy = BIT(4),
   kProofConnectGrid = BIT(5),
   kOneStageMerging = BIT(6)
};

   AliAnalysisGrid() : TNamed(), fSpecialBits(0) {}
   AliAnalysisGrid(const char *name) : TNamed(name,""), fSpecialBits(0) {}
   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        SetValidationScript(const char *name="validation.sh")     = 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:std*@disk=1 root_archive.zip:*.root@disk=2") = 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        SetTerminateFiles(const char *list)               = 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;

// Flags
   Bool_t              IsUseCopy() const {return TestSpecialBit(kUseCopy);}
   void                SetUseCopy(Bool_t flag=kTRUE) {SetSpecialBit(kUseCopy,flag);}
   Bool_t              IsCheckCopy() const {return TestSpecialBit(kCheckCopy);}
   void                SetCheckCopy(Bool_t flag=kTRUE) {SetSpecialBit(kCheckCopy,flag);}
   Bool_t              IsKeepLogs() const {return TestSpecialBit(kKeepLogs);}
   void                SetKeepLogs(Bool_t flag=kTRUE) {SetSpecialBit(kKeepLogs,flag);}   
   Bool_t              IsUseSubmitPolicy() const {return TestSpecialBit(kUseSubmitPolicy);}
   void                SetUseSubmitPolicy(Bool_t flag=kTRUE) {SetSpecialBit(kUseSubmitPolicy,flag);}   
   Bool_t              IsOneStageMerging() const {return TestSpecialBit(kOneStageMerging);}
   void                SetOneStageMerging(Bool_t flag) {SetSpecialBit(kOneStageMerging,flag);}

// PROOF mode
   virtual void        SetProofCluster(const char *cluster)              = 0;
   virtual void        SetProofDataSet(const char *dataset)              = 0;
   virtual const char *GetProofDataSet() const                           = 0;
   virtual void        SetProofReset(Int_t mode)                         = 0;
   virtual void        SetClearPackages(Bool_t flag=kTRUE) {SetSpecialBit(kClearPackages,flag);}
   virtual void        SetProofConnectGrid(Bool_t flag=kTRUE) {SetSpecialBit(kProofConnectGrid,flag);}
   virtual void        SetNproofWorkers(Int_t nworkers)                  = 0;
   virtual void        SetNproofWorkersPerSlave(Int_t nworkers)          = 0;
   virtual void        SetRootVersionForProof(const char *version)       = 0;
   virtual void        SetAliRootMode(const char *mode)                  = 0;
   // .txt file containing the list of files to be chained in test mode
   virtual void        SetFileForTestMode(const char *filename)          = 0;
   virtual TChain     *GetChainForTestMode(const char *treeName) const   = 0;

protected:
// Methods
   virtual Bool_t      Connect()                                         = 0;
   virtual void        SetDefaults()                                     = 0;
   void     SetSpecialBit(UInt_t f) { fSpecialBits |= f & kBitMask32; }
   void     ResetSpecialBit(UInt_t f) { fSpecialBits &= ~(f & kBitMask32); }
   void     SetSpecialBit(UInt_t f, Bool_t set) {(set)?SetSpecialBit(f):ResetSpecialBit(f);}
   Bool_t   TestSpecialBit(UInt_t f) const { return (Bool_t) ((fSpecialBits & f) != 0); }
   Int_t    TestSpecialBits(UInt_t f) const { return (Int_t) (fSpecialBits & f); }
   void     InvertSpecialBit(UInt_t f) { fSpecialBits ^= f & kBitMask32; }

protected:
   UInt_t              fSpecialBits; // special bits
  

   ClassDef(AliAnalysisGrid, 2)   // 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
3bdcb562	17	class TChain;
3bdcb562	18
c57f56b7	19	class AliAnalysisGrid : public TNamed {
	20
	21	public:
	22
	23	enum EPluginRunMode {
	24	kFull = 0,
	25	kTest = BIT(14),
	26	kOffline = BIT(15),
	27	kSubmit = BIT(16),
	28	kMerge = BIT(17),
	29	kUseTags = BIT(18),
	30	kUseESD = BIT(19),
	31	kUseAOD = BIT(20),
4e5c5506	32	kUseMC = BIT(21),
bb885a9e	33	kUsePars = BIT(22),
a3e84053	34	kDefaultOutputs = BIT(23)
c57f56b7	35	};
348be253	36	enum EPluginBits {
	37	kBitMask32 = 0xffffffff,
	38	kUseCopy = BIT(0),
149d288c	39	kCheckCopy = BIT(1),
3bdcb562	40	kKeepLogs = BIT(2),
3bdcb562	41	kClearPackages = BIT(3),
27734f0e	42	kUseSubmitPolicy = BIT(4),
d3b18c4c	43	kProofConnectGrid = BIT(5),
d3b18c4c	44	kOneStageMerging = BIT(6)
348be253	45	};
c57f56b7	46
348be253	47	AliAnalysisGrid() : TNamed(), fSpecialBits(0) {}
348be253	48	AliAnalysisGrid(const char *name) : TNamed(name,""), fSpecialBits(0) {}
c57f56b7	49	virtual ~AliAnalysisGrid() {}
	50	AliAnalysisGrid(const AliAnalysisGrid& other);
	51	AliAnalysisGrid& operator=(const AliAnalysisGrid& other);
	52	// Getters
	53	virtual EPluginRunMode GetRunMode() const;
	54	// Setters
f965131e	55	virtual void AddIncludePath(const char *path) = 0;
c57f56b7	56	virtual void AddRunNumber(Int_t run) = 0;
ee75cfc3	57	virtual void AddRunNumber(const char *run) = 0;
c57f56b7	58	virtual void AddDataFile(const char *lfn) = 0;
fe2d7fc2	59	virtual Bool_t IsSingleOutput() const = 0;
c57f56b7	60	virtual void SetExecutable(const char *name="analysis.sh") = 0;
	61	virtual void SetArguments(const char *name="") = 0;
	62	virtual void SetAnalysisMacro(const char *name="myAnalysis.C") = 0;
	63	virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0;
d3b18c4c	64	virtual void SetValidationScript(const char *name="validation.sh") = 0;
c57f56b7	65	virtual void SetAdditionalLibs(const char *list) = 0;
c57f56b7	66	virtual void SetPrice(Int_t price=1) = 0;
c6cb3634	67	virtual void SetJobTag(const char *tag="") = 0;
c57f56b7	68	virtual void SetSplitMode(const char *type="se") = 0;
	69	virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) = 0;
	70	virtual void SetAPIVersion(const char *version) = 0;
	71	virtual void SetROOTVersion(const char *version) = 0;
	72	virtual void SetAliROOTVersion(const char *version) = 0;
	73	virtual void SetUser(const char *user) = 0;
	74	virtual void SetTTL(Int_t ttl=30000) = 0;
	75	virtual void SetGridWorkingDir(const char *name="workdir") = 0;
	76	virtual void SetGridDataDir(const char *name) = 0;
	77	virtual void SetDataPattern(const char *pattern) = 0;
bb885a9e	78	virtual void SetDefaultOutputs(Bool_t flag=kTRUE) = 0;
c57f56b7	79	virtual void SetGridOutputDir(const char *name="output") = 0;
149d288c	80	virtual void SetOutputArchive(const char list="log_archive.zip:std@disk=1 root_archive.zip:*.root@disk=2") = 0;
c57f56b7	81	virtual void SetOutputFiles(const char *list) = 0;
	82	virtual void SetInputFormat(const char *format="xml-single") = 0;
	83	virtual void SetMaxInitFailed(Int_t nfail=5) = 0;
d3b18c4c	84	virtual void SetTerminateFiles(const char *list) = 0;
bb885a9e	85	virtual void SetMergeExcludes(const char *list) = 0;
0f389141	86	virtual void SetMergeViaJDL(Bool_t on=kTRUE) = 0;
c57f56b7	87	virtual void SetMasterResubmitThreshold(Int_t percentage) = 0;
bb885a9e	88	virtual void SetNtestFiles(Int_t nfiles) = 0;
c57f56b7	89	virtual void SetJDLName(const char *name="analysis.jdl") = 0;
43da816a	90	virtual void SetPreferedSE(const char *se) = 0;
0f389141	91	virtual void SetProductionMode(Int_t mode=1) = 0;
	92	virtual void SetRunPrefix(const char *prefix) = 0;
	93	virtual void SetOutputSingleFolder(const char *folder) = 0;
	94	virtual void SetFastReadOption(Bool_t on=kTRUE) = 0;
	95	virtual void SetOverwriteMode(Bool_t on=kTRUE) = 0;
c57f56b7	96
	97	// Set run mode. Can be "full", "test", "offline", "submit" or "merge"
	98	virtual void SetRunMode(const char *mode="full");
	99	//Utilities
	100	static Bool_t CreateToken(const char *username=0);
	101	virtual Bool_t CreateDataset(const char *pattern) = 0;
	102	virtual Bool_t CreateJDL() = 0;
4e5c5506	103	virtual void EnablePackage(const char *package) = 0;
c57f56b7	104	virtual Bool_t MergeOutputs() = 0;
5513444a	105	virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0;
c57f56b7	106	virtual void WriteAnalysisFile() = 0;
	107	virtual void WriteAnalysisMacro() = 0;
	108	virtual void WriteExecutable() = 0;
0f389141	109	virtual void WriteValidationScript(Bool_t merge=kFALSE) = 0;
c57f56b7	110
348be253	111	// Flags
	112	Bool_t IsUseCopy() const {return TestSpecialBit(kUseCopy);}
	113	void SetUseCopy(Bool_t flag=kTRUE) {SetSpecialBit(kUseCopy,flag);}
	114	Bool_t IsCheckCopy() const {return TestSpecialBit(kCheckCopy);}
	115	void SetCheckCopy(Bool_t flag=kTRUE) {SetSpecialBit(kCheckCopy,flag);}
149d288c	116	Bool_t IsKeepLogs() const {return TestSpecialBit(kKeepLogs);}
149d288c	117	void SetKeepLogs(Bool_t flag=kTRUE) {SetSpecialBit(kKeepLogs,flag);}
3bdcb562	118	Bool_t IsUseSubmitPolicy() const {return TestSpecialBit(kUseSubmitPolicy);}
3bdcb562	119	void SetUseSubmitPolicy(Bool_t flag=kTRUE) {SetSpecialBit(kUseSubmitPolicy,flag);}
d3b18c4c	120	Bool_t IsOneStageMerging() const {return TestSpecialBit(kOneStageMerging);}
d3b18c4c	121	void SetOneStageMerging(Bool_t flag) {SetSpecialBit(kOneStageMerging,flag);}
3bdcb562	122
	123	// PROOF mode
	124	virtual void SetProofCluster(const char *cluster) = 0;
	125	virtual void SetProofDataSet(const char *dataset) = 0;
	126	virtual const char *GetProofDataSet() const = 0;
	127	virtual void SetProofReset(Int_t mode) = 0;
	128	virtual void SetClearPackages(Bool_t flag=kTRUE) {SetSpecialBit(kClearPackages,flag);}
27734f0e	129	virtual void SetProofConnectGrid(Bool_t flag=kTRUE) {SetSpecialBit(kProofConnectGrid,flag);}
3bdcb562	130	virtual void SetNproofWorkers(Int_t nworkers) = 0;
27734f0e	131	virtual void SetNproofWorkersPerSlave(Int_t nworkers) = 0;
3bdcb562	132	virtual void SetRootVersionForProof(const char *version) = 0;
	133	virtual void SetAliRootMode(const char *mode) = 0;
	134	// .txt file containing the list of files to be chained in test mode
	135	virtual void SetFileForTestMode(const char *filename) = 0;
	136	virtual TChain GetChainForTestMode(const char treeName) const = 0;
348be253	137
c57f56b7	138	protected:
348be253	139	// Methods
c57f56b7	140	virtual Bool_t Connect() = 0;
348be253	141	virtual void SetDefaults() = 0;
	142	void SetSpecialBit(UInt_t f) { fSpecialBits \|= f & kBitMask32; }
	143	void ResetSpecialBit(UInt_t f) { fSpecialBits &= ~(f & kBitMask32); }
	144	void SetSpecialBit(UInt_t f, Bool_t set) {(set)?SetSpecialBit(f):ResetSpecialBit(f);}
	145	Bool_t TestSpecialBit(UInt_t f) const { return (Bool_t) ((fSpecialBits & f) != 0); }
	146	Int_t TestSpecialBits(UInt_t f) const { return (Int_t) (fSpecialBits & f); }
	147	void InvertSpecialBit(UInt_t f) { fSpecialBits ^= f & kBitMask32; }
	148
	149	protected:
	150	UInt_t fSpecialBits; // special bits
	151
	152
	153	ClassDef(AliAnalysisGrid, 2) // Base class for GRID utilities
c57f56b7	154	};
c57f56b7	155	#endif