ROOT logo
AliRoot » ANALYSIS » AliAnalysisGrid

class AliAnalysisGrid: public TNamed

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

Function Members (Methods)

 
    This is an abstract class, constructors will not be documented.
    Look at the header to check for available constructors.

public:
virtual~AliAnalysisGrid()
voidTObject::AbstractMethod(const char* method) const
virtual voidAddAdditionalLibrary(const char* name)
virtual voidAddDataFile(const char* lfn)
virtual voidAddIncludePath(const char* path)
virtual voidAddRunNumber(Int_t run)
virtual voidAddRunNumber(const char* run)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
virtual Bool_tCreateDataset(const char* pattern)
virtual Bool_tCreateJDL()
static Bool_tCreateToken(const char* username = 0)
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidEnablePackage(const char* package)
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual TChain*GetChainForTestMode(const char* treeName) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
virtual const char*GetProofDataSet() const
virtual TStringGetProofProcessOpt()
virtual AliAnalysisGrid::EPluginRunModeGetRunMode() const
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
Bool_tIsCheckCopy() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tIsKeepLogs() const
Bool_tIsLocalTest() const
Bool_tIsMergeAOD() const
Bool_tIsOneStageMerging() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tIsSingleOutput() const
virtual Bool_tTNamed::IsSortable() const
Bool_tIsUseCopy() const
Bool_tIsUseMCchain() const
Bool_tIsUseSubmitPolicy() const
Bool_tTObject::IsZombie() const
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tMergeOutputs()
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
AliAnalysisGrid&operator=(const AliAnalysisGrid& other)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTNamed::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
virtual voidSetAdditionalLibs(const char* list)
virtual voidSetAliRootMode(const char* mode)
virtual voidSetAliROOTVersion(const char* version)
virtual voidSetAnalysisMacro(const char* name = "myAnalysis.C")
virtual voidSetAnalysisSource(const char* name = "myAnalysisClass.cxx")
virtual voidSetAPIVersion(const char* version)
virtual voidSetArguments(const char* name = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
voidSetCheckCopy(Bool_t flag = kTRUE)
virtual voidSetClearPackages(Bool_t flag = kTRUE)
virtual voidSetDataPattern(const char* pattern)
virtual voidSetDefaultOutputs(Bool_t flag = kTRUE)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
virtual voidSetExecutable(const char* name = "analysis.sh")
virtual voidSetFastReadOption(Bool_t on = kTRUE)
virtual voidSetFileForTestMode(const char* filename)
virtual voidSetGridDataDir(const char* name)
virtual voidSetGridOutputDir(const char* name = "output")
virtual voidSetGridWorkingDir(const char* name = "workdir")
virtual voidSetInputFormat(const char* format = "xml-single")
virtual voidSetJDLName(const char* name = "analysis.jdl")
virtual voidSetJobTag(const char* tag = "")
voidSetKeepLogs(Bool_t flag = kTRUE)
voidSetLocalTest(Bool_t flag = kTRUE)
virtual voidSetMasterResubmitThreshold(Int_t percentage)
virtual voidSetMaxInitFailed(Int_t nfail = 5)
virtual voidSetMergeAOD(Bool_t flag = kTRUE)
virtual voidSetMergeExcludes(const char* list)
virtual voidSetMergeViaJDL(Bool_t on = kTRUE)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
virtual voidSetNproofWorkers(Int_t nworkers)
virtual voidSetNproofWorkersPerSlave(Int_t nworkers)
virtual voidSetNtestFiles(Int_t nfiles)
static voidTObject::SetObjectStat(Bool_t stat)
voidSetOneStageMerging(Bool_t flag)
virtual voidSetOutputArchive(const char* list = "log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2")
virtual voidSetOutputFiles(const char* list)
virtual voidSetOutputSingleFolder(const char* folder)
virtual voidSetOverwriteMode(Bool_t on = kTRUE)
virtual voidSetPrice(Int_t price = 1)
virtual voidSetProductionMode(Int_t mode = 1)
virtual voidSetProofCluster(const char* cluster)
virtual voidSetProofConnectGrid(Bool_t flag = kTRUE)
virtual voidSetProofDataSet(const char* dataset)
virtual voidSetProofProcessOpt(const char* proofOpt = "")
virtual voidSetProofReset(Int_t mode)
virtual voidSetRegisterExcludes(const char* list)
virtual voidSetROOTVersion(const char* version)
virtual voidSetRootVersionForProof(const char* version)
virtual voidSetRunMode(const char* mode = "full")
virtual voidSetRunPrefix(const char* prefix)
virtual voidSetSplitMaxInputFileNumber(Int_t nfiles = 100)
virtual voidSetSplitMode(const char* type = "se")
virtual voidSetTerminateFiles(const char* list)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidSetTTL(Int_t ttl = 30000)
virtual voidTObject::SetUniqueID(UInt_t uid)
voidSetUseCopy(Bool_t flag = kTRUE)
voidSetUseMCchain(Bool_t flag = kTRUE)
virtual voidSetUser(const char* user)
voidSetUseSubmitPolicy(Bool_t flag = kTRUE)
virtual voidSetValidationScript(const char* name = "validation.sh")
virtual voidShowMembers(TMemberInspector&)
virtual Int_tTNamed::Sizeof() const
virtual Bool_tStartAnalysis(Long64_t nentries = 123456789, Long64_t firstentry = 0)
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual voidWriteAnalysisFile()
virtual voidWriteAnalysisMacro()
virtual voidWriteExecutable()
virtual voidWriteValidationScript(Bool_t merge = kFALSE)
protected:
virtual Bool_tConnect()
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidInvertSpecialBit(UInt_t f)
voidTObject::MakeZombie()
voidResetSpecialBit(UInt_t f)
virtual voidSetDefaults()
voidSetSpecialBit(UInt_t f)
voidSetSpecialBit(UInt_t f, Bool_t set)
Bool_tTestSpecialBit(UInt_t f) const
Int_tTestSpecialBits(UInt_t f) const

Data Members

public:
enum EPluginRunMode { kFull
kTest
kOffline
kSubmit
kMerge
kUseTags
kUseESD
kUseAOD
kUseMC
kUsePars
kDefaultOutputs
};
enum EPluginBits { kBitMask32
kUseCopy
kCheckCopy
kKeepLogs
kClearPackages
kUseSubmitPolicy
kProofConnectGrid
kOneStageMerging
kUseMCchain
kLocalTest
kMergeAOD
};
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TStringTNamed::fNameobject identifier
UInt_tfSpecialBitsspecial bits
TStringTNamed::fTitleobject title

Class Charts

Inheritance Chart:
TNamed
AliAnalysisGrid
AliAnalysisAlien

Function documentation

AliAnalysisGrid & operator=(const AliAnalysisGrid& other)
 Assignment.
Bool_t CreateToken(const char* username = 0)
 Check if a valid token exists - if not create one
void SetRunMode(const char* mode = "full")
 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.
virtual ~AliAnalysisGrid()
{}
EPluginRunMode GetRunMode() const
 Getters
void AddAdditionalLibrary(const char* name)
 Setters
void AddIncludePath(const char* path)
void AddRunNumber(Int_t run)
void AddRunNumber(const char* run)
void AddDataFile(const char* lfn)
Bool_t IsSingleOutput() const
void SetExecutable(const char* name = "analysis.sh")
void SetArguments(const char* name = "")
void SetAnalysisMacro(const char* name = "myAnalysis.C")
void SetAnalysisSource(const char* name = "myAnalysisClass.cxx")
void SetValidationScript(const char* name = "validation.sh")
void SetAdditionalLibs(const char* list)
void SetPrice(Int_t price = 1)
void SetJobTag(const char* tag = "")
void SetSplitMode(const char* type = "se")
void SetSplitMaxInputFileNumber(Int_t nfiles = 100)
void SetAPIVersion(const char* version)
void SetROOTVersion(const char* version)
void SetAliROOTVersion(const char* version)
void SetUser(const char* user)
void SetTTL(Int_t ttl = 30000)
void SetGridWorkingDir(const char* name = "workdir")
void SetGridDataDir(const char* name)
void SetDataPattern(const char* pattern)
void SetDefaultOutputs(Bool_t flag = kTRUE)
void SetGridOutputDir(const char* name = "output")
void SetOutputArchive(const char* list = "log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2")
void SetOutputFiles(const char* list)
void SetInputFormat(const char* format = "xml-single")
void SetMaxInitFailed(Int_t nfail = 5)
void SetTerminateFiles(const char* list)
void SetMergeExcludes(const char* list)
void SetMergeViaJDL(Bool_t on = kTRUE)
void SetMasterResubmitThreshold(Int_t percentage)
void SetNtestFiles(Int_t nfiles)
void SetJDLName(const char* name = "analysis.jdl")
void SetProductionMode(Int_t mode = 1)
void SetRegisterExcludes(const char* list)
void SetRunPrefix(const char* prefix)
void SetOutputSingleFolder(const char* folder)
void SetFastReadOption(Bool_t on = kTRUE)
void SetOverwriteMode(Bool_t on = kTRUE)
Bool_t CreateDataset(const char* pattern)
Bool_t CreateJDL()
void EnablePackage(const char* package)
Bool_t MergeOutputs()
Bool_t StartAnalysis(Long64_t nentries = 123456789, Long64_t firstentry = 0)
void WriteAnalysisFile()
void WriteAnalysisMacro()
void WriteExecutable()
void WriteValidationScript(Bool_t merge = kFALSE)
Bool_t IsUseCopy() const
 Flags
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
void SetMergeAOD(Bool_t flag = kTRUE)
void SetProofCluster(const char* cluster)
 PROOF mode
void SetProofDataSet(const char* dataset)
const char * GetProofDataSet() const
void SetProofReset(Int_t mode)
void SetClearPackages(Bool_t flag = kTRUE)
void SetProofConnectGrid(Bool_t flag = kTRUE)
void SetNproofWorkers(Int_t nworkers)
void SetNproofWorkersPerSlave(Int_t nworkers)
void SetRootVersionForProof(const char* version)
void SetAliRootMode(const char* mode)
void SetProofProcessOpt(const char* proofOpt = "")
TString GetProofProcessOpt()
 .txt file containing the list of files to be chained in test mode
void SetFileForTestMode(const char* filename)
TChain * GetChainForTestMode(const char* treeName) const
Bool_t Connect()
 Methods
void SetDefaults()
void SetSpecialBit(UInt_t f)
void ResetSpecialBit(UInt_t f)
{ fSpecialBits &= ~(f & kBitMask32); }
void SetSpecialBit(UInt_t f, Bool_t set)
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)