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

#include <AliAnalysisGrid.h>

Inheritance diagram for AliAnalysisGrid:

[legend]

Public Types
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), kUseMCchain = BIT(7), kLocalTest = BIT(8), kMergeAOD = BIT(9) }

Public Member Functions
	AliAnalysisGrid ()

	AliAnalysisGrid (const char *name)

virtual	~AliAnalysisGrid ()

	AliAnalysisGrid (const AliAnalysisGrid &other)

AliAnalysisGrid &	operator= (const AliAnalysisGrid &other)

virtual EPluginRunMode	GetRunMode () const

virtual void	AddAdditionalLibrary (const char *name)=0

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	SetAliPhysicsVersion (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	SetProductionMode (Int_t mode=1)=0

virtual void	SetRegisterExcludes (const char *list)=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

virtual void	SetRunMode (const char *mode="full")

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 (Long64_t nentries=123456789, Long64_t firstentry=0)=0

virtual void	WriteExecutable ()=0

virtual void	WriteValidationScript (Bool_t merge=kFALSE)=0

Bool_t	IsUseCopy () const

void	SetUseCopy (Bool_t flag=kTRUE)

Bool_t	IsCheckCopy () const

void	SetCheckCopy (Bool_t flag=kTRUE)

Bool_t	IsKeepLogs () const

void	SetKeepLogs (Bool_t flag=kTRUE)

Bool_t	IsUseSubmitPolicy () const

void	SetUseSubmitPolicy (Bool_t flag=kTRUE)

Bool_t	IsOneStageMerging () const

void	SetOneStageMerging (Bool_t flag)

Bool_t	IsUseMCchain () const

void	SetUseMCchain (Bool_t flag=kTRUE)

Bool_t	IsLocalTest () const

void	SetLocalTest (Bool_t flag=kTRUE)

Bool_t	IsMergeAOD () const

virtual void	SetMergeAOD (Bool_t flag=kTRUE)

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)

virtual void	SetProofConnectGrid (Bool_t flag=kTRUE)

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

virtual void	SetProofProcessOpt (const char *proofOpt="")=0

virtual TString	GetProofProcessOpt ()=0

virtual void	SetFileForTestMode (const char *filename)=0

virtual TChain *	GetChainForTestMode (const char *treeName) const =0

Static Public Member Functions
static Bool_t	CreateToken (const char *username=0)

Protected Member Functions
virtual Bool_t	Connect ()=0

virtual void	SetDefaults ()=0

void	SetSpecialBit (UInt_t f)

void	ResetSpecialBit (UInt_t f)

void	SetSpecialBit (UInt_t f, Bool_t set)

Bool_t	TestSpecialBit (UInt_t f) const

Int_t	TestSpecialBits (UInt_t f) const

void	InvertSpecialBit (UInt_t f)

Protected Attributes
UInt_t	fSpecialBits
	special bits More...

Detailed Description

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

Author: Mihaela Gheata

Date: 01/09/2008

Definition at line 19 of file AliAnalysisGrid.h.

Member Enumeration Documentation

enum AliAnalysisGrid::EPluginBits

Enumerator
kBitMask32
kUseCopy
kCheckCopy
kKeepLogs
kClearPackages
kUseSubmitPolicy
kProofConnectGrid
kOneStageMerging
kUseMCchain
kLocalTest
kMergeAOD

Definition at line 36 of file AliAnalysisGrid.h.

enum AliAnalysisGrid::EPluginRunMode

Enumerator
kFull
kTest
kOffline
kSubmit
kMerge
kUseTags
kUseESD
kUseAOD
kUseMC
kUsePars
kDefaultOutputs

Definition at line 23 of file AliAnalysisGrid.h.

Constructor & Destructor Documentation

AliAnalysisGrid::AliAnalysisGrid ( )

inline

Definition at line 50 of file AliAnalysisGrid.h.

Referenced by ~AliAnalysisGrid().

AliAnalysisGrid::AliAnalysisGrid ( const char * name )

inline

Definition at line 51 of file AliAnalysisGrid.h.

virtual AliAnalysisGrid::~AliAnalysisGrid ( )

inlinevirtual

Definition at line 52 of file AliAnalysisGrid.h.

AliAnalysisGrid::AliAnalysisGrid ( const AliAnalysisGrid & other )

Definition at line 24 of file AliAnalysisGrid.cxx.

Member Function Documentation

virtual void AliAnalysisGrid::AddAdditionalLibrary ( const char * name )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::AddDataFile ( const char * lfn )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::AddIncludePath ( const char * path )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::AddRunNumber ( Int_t run )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::AddRunNumber ( const char * run )

pure virtual

Implemented in AliAnalysisAlien.

virtual Bool_t AliAnalysisGrid::Connect ( )

protectedpure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual Bool_t AliAnalysisGrid::CreateDataset ( const char * pattern )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual Bool_t AliAnalysisGrid::CreateJDL ( )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

Bool_t AliAnalysisGrid::CreateToken ( const char * username = 0 )

static

Check if a valid token exists - if not create one

Definition at line 43 of file AliAnalysisGrid.cxx.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::EnablePackage ( const char * package )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual TChain* AliAnalysisGrid::GetChainForTestMode ( const char * treeName ) const

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid(), and AliAnalysisManager::StartAnalysis().

virtual const char* AliAnalysisGrid::GetProofDataSet ( ) const

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetMergeAOD(), and AliAnalysisManager::StartAnalysis().

virtual TString AliAnalysisGrid::GetProofProcessOpt ( )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid(), and AliAnalysisManager::StartAnalysis().

AliAnalysisGrid::EPluginRunMode AliAnalysisGrid::GetRunMode ( ) const

virtual

Get the current run mode.

Definition at line 52 of file AliAnalysisGrid.cxx.

Referenced by AliAnalysisManager::StartAnalysis(), and ~AliAnalysisGrid().

void AliAnalysisGrid::InvertSpecialBit ( UInt_t f )

inlineprotected

Definition at line 160 of file AliAnalysisGrid.h.

Bool_t AliAnalysisGrid::IsCheckCopy ( ) const

inline

Definition at line 119 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::Print(), and AliAnalysisAlien::StartAnalysis().

Bool_t AliAnalysisGrid::IsKeepLogs ( ) const

inline

Definition at line 121 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::WriteValidationScript().

Bool_t AliAnalysisGrid::IsLocalTest ( ) const

inline

Definition at line 129 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::WriteAnalysisMacro(), and AliAnalysisAlien::WriteMergingMacro().

Bool_t AliAnalysisGrid::IsMergeAOD ( ) const

inline

Definition at line 131 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::CreateJDL(), and AliAnalysisAlien::WriteMergingMacro().

Bool_t AliAnalysisGrid::IsOneStageMerging ( ) const

inline

Definition at line 125 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::CreateJDL(), and AliAnalysisAlien::WriteMergeExecutable().

virtual Bool_t AliAnalysisGrid::IsSingleOutput ( ) const

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

Bool_t AliAnalysisGrid::IsUseCopy ( ) const

inline

Definition at line 117 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::Print().

Bool_t AliAnalysisGrid::IsUseMCchain ( ) const

inline

Definition at line 127 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::GetChainForTestMode(), and AliAnalysisAlien::WriteAnalysisMacro().

Bool_t AliAnalysisGrid::IsUseSubmitPolicy ( ) const

inline

Definition at line 123 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::SubmitNext().

virtual Bool_t AliAnalysisGrid::MergeOutputs ( )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by AliAnalysisManager::StartAnalysis(), and ~AliAnalysisGrid().

AliAnalysisGrid & AliAnalysisGrid::operator= ( const AliAnalysisGrid & other )

Assignment.

Definition at line 31 of file AliAnalysisGrid.cxx.

Referenced by AliAnalysisAlien::operator=(), and ~AliAnalysisGrid().

void AliAnalysisGrid::ResetSpecialBit ( UInt_t f )

inlineprotected

Definition at line 156 of file AliAnalysisGrid.h.

Referenced by SetSpecialBit().

virtual void AliAnalysisGrid::SetAdditionalLibs ( const char * list )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetAliPhysicsVersion ( const char * version )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetAliRootMode ( const char * mode )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual void AliAnalysisGrid::SetAliROOTVersion ( const char * version )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetAnalysisMacro ( const char * name = "myAnalysis.C" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetAnalysisSource ( const char * name = "myAnalysisClass.cxx" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetAPIVersion ( const char * version )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetArguments ( const char * name = "" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

void AliAnalysisGrid::SetCheckCopy ( Bool_t flag = kTRUE )

inline

Definition at line 120 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::SetDefaults(), and SetRunMode().

virtual void AliAnalysisGrid::SetClearPackages ( Bool_t flag = kTRUE )

inlinevirtual

Definition at line 139 of file AliAnalysisGrid.h.

virtual void AliAnalysisGrid::SetDataPattern ( const char * pattern )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetDefaultOutputs ( Bool_t flag = kTRUE )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetDefaults ( )

protectedpure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual void AliAnalysisGrid::SetExecutable ( const char * name = "analysis.sh" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetFastReadOption ( Bool_t on = kTRUE )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetFileForTestMode ( const char * filename )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual void AliAnalysisGrid::SetGridDataDir ( const char * name )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetGridOutputDir ( const char * name = "output" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetGridWorkingDir ( const char * name = "workdir" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetInputFormat ( const char * format = "xml-single" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetJDLName ( const char * name = "analysis.jdl" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetJobTag ( const char * tag = "" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

void AliAnalysisGrid::SetKeepLogs ( Bool_t flag = kTRUE )

inline

Definition at line 122 of file AliAnalysisGrid.h.

void AliAnalysisGrid::SetLocalTest ( Bool_t flag = kTRUE )

inline

Definition at line 130 of file AliAnalysisGrid.h.

Referenced by AliAnalysisAlien::GenerateTest().

virtual void AliAnalysisGrid::SetMasterResubmitThreshold ( Int_t percentage )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetMaxInitFailed ( Int_t nfail = 5 )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetMergeAOD ( Bool_t flag = kTRUE )

inlinevirtual

Definition at line 132 of file AliAnalysisGrid.h.

virtual void AliAnalysisGrid::SetMergeExcludes ( const char * list )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetMergeViaJDL ( Bool_t on = kTRUE )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetNproofWorkers ( Int_t nworkers )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual void AliAnalysisGrid::SetNproofWorkersPerSlave ( Int_t nworkers )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual void AliAnalysisGrid::SetNtestFiles ( Int_t nfiles )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

void AliAnalysisGrid::SetOneStageMerging ( Bool_t flag )

inline

Definition at line 126 of file AliAnalysisGrid.h.

virtual void AliAnalysisGrid::SetOutputArchive ( const char * list = "log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetOutputFiles ( const char * list )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetOutputSingleFolder ( const char * folder )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetOverwriteMode ( Bool_t on = kTRUE )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetPrice ( Int_t price = 1 )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetProductionMode ( Int_t mode = 1 )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetProofCluster ( const char * cluster )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetMergeAOD().

virtual void AliAnalysisGrid::SetProofConnectGrid ( Bool_t flag = kTRUE )

inlinevirtual

Definition at line 140 of file AliAnalysisGrid.h.

virtual void AliAnalysisGrid::SetProofDataSet ( const char * dataset )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetMergeAOD().

virtual void AliAnalysisGrid::SetProofProcessOpt ( const char * proofOpt = "" )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

virtual void AliAnalysisGrid::SetProofReset ( Int_t mode )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetMergeAOD().

virtual void AliAnalysisGrid::SetRegisterExcludes ( const char * list )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetROOTVersion ( const char * version )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetRootVersionForProof ( const char * version )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by SetProofConnectGrid().

void AliAnalysisGrid::SetRunMode ( const char * mode = "full" )

virtual

Set the alien plugin run mode. All modes require presence of a valid token and sourcing the AliEn environment. Supported modes are:

full (default): Generates requested datasets, locally generates the JDL, saves existing analysis manager to the file analysis.root, generates analysis macro, execution and validation scripts, copies all these files to AliEn working space and submits the job leaving user in an AliEn shell.
test : Generates only 10 entries of the first requested dataset and copies this locally as wn.xml, generates all files from the full run mode except the JDL and executes the analysis locally. This mode can be used to test if the analysis may run in grid.
offline : No dataset is produced, but all other files are locally generated. No file is copied in AliEn workspace. This mode can be used to customize the automatic JDL/analysis macro.
submit : Datasets are generated in AliEn but the JDL and all the other files are supposed to exist in the local directory. The files are copied to AliEn and the job is submitted. This mode should be used in correlation with "offline mode" to submit customized analysis macro/jdl.
merge : Only MergeOutputs() method called to merge the registered outputs of a job that finished.

Definition at line 64 of file AliAnalysisGrid.cxx.

Referenced by ~AliAnalysisGrid().

virtual void AliAnalysisGrid::SetRunPrefix ( const char * prefix )

pure virtual

Implemented in AliAnalysisAlien.

Referenced by ~AliAnalysisGrid().

void AliAnalysisGrid::SetSpecialBit ( UInt_t f )

inlineprotected

Definition at line 155 of file AliAnalysisGrid.h.

Referenced by SetCheckCopy(), SetClearPackages(), SetKeepLogs(), SetLocalTest(), SetMergeAOD(), SetOneStageMerging(), SetProofConnectGrid(), SetUseCopy(), SetUseMCchain(), and SetUseSubmitPolicy().