AliPhysics  a6017e1 (a6017e1)
VAFRailway Struct Reference
Inheritance diagram for VAFRailway:

Public Member Functions

 VAFRailway (const TUrl &url, Int_t verbose)
 
virtual ~VAFRailway ()
 
virtual Bool_t LoadAliROOT ()
 
virtual const char * AliPhysicsParName () const
 
virtual Bool_t CreateAliPhysicsPar ()
 
virtual Bool_t EnableAliPhysics ()
 
virtual const char * AliROOTParName () const
 
virtual Bool_t CreateAliROOTPar ()
 
virtual Bool_t PreSetup ()
 
virtual void GetDataSet (TString &dsName)
 
virtual Bool_t Connect (const TUrl &url, const TString &opt)
 
virtual const Char_tUrlHelp () const
 
virtual const char * Desc () const
 
- Public Member Functions inherited from ProofRailway
 ProofRailway (const TUrl &url, Int_t verbose)
 
 ProofRailway (const ProofRailway &o)
 
ProofRailwayoperator= (const ProofRailway &o)
 
virtual ~ProofRailway ()
 
void UsePar (Bool_t &use)
 
virtual Bool_t AddIncludePath (const TString &path)
 
virtual Bool_t LoadLibrary (const TString &name, Bool_t slaves=true, Bool_t forcePar=false)
 
virtual Bool_t LoadSource (const TString &name, bool copy=true)
 
virtual Bool_t LoadAliPhysics ()
 
virtual Bool_t CreatePseudoPar (const TString &parName, const TString &env, const TString &setup)
 
virtual UShort_t Mode () const
 
virtual const char * ModeString () const
 
virtual Bool_t EnableSpecial (const TString &parName, const TString &prefix)
 
virtual Bool_t EnableAliROOT ()
 
virtual Bool_t PostSetup ()
 
virtual Bool_t LoadExtraSrcs ()
 
virtual Long64_t Run (Long64_t nEvents=-1)
 
virtual void Print (Option_t *option="") const
 
virtual Bool_t AuxFile (TString &name, bool copy=false)
 
Int_t SendFile (const TString &fileName)
 
virtual TString OutputPath () const
 
void AuxSave (const TString &escaped, Bool_t)
 
- Public Member Functions inherited from Railway
 Railway (const Railway &o)
 
Railwayoperator= (const Railway &)
 
virtual Bool_t LoadAux (const TString &name, Bool_t copy=false)
 
virtual Bool_t LoadROOT ()
 
virtual UShort_t Operation () const
 
virtual Bool_t AddMonitor (const TString &)
 
virtual Short_t InputType () const
 
virtual Bool_t IsMC () const
 
virtual TString OutputLocation () const
 
const TUrlUrl () const
 
const OptionListOptions () const
 

Additional Inherited Members

- Public Types inherited from Railway
enum  EMode { kLocal, kProof, kGrid }
 
enum  EOperation {
  kTest, kOffline, kSubmit, kTerminate,
  kFull
}
 
enum  EInput { kESD, kAOD, kUser }
 
- Static Public Member Functions inherited from ProofRailway
static void ExportEnvVar (TString &out, const TString &name)
 
- Static Public Member Functions inherited from Railway
static RailwayCreate (const TUrl &url, Int_t verbose=0)
 
static RailwayCreateObject (const TString &cl, const TUrl &url, Int_t verbose=0)
 
static void ShowUrlHelp (const TString &cl)
 
static void ShowFullHelp (const TString &cl)
 
- Public Attributes inherited from ProofRailway
TString fExtraLibs
 
TString fExtraPars
 
TString fExtraSrcs
 
Bool_t fUsePars
 
Bool_t fBasePars
 
Bool_t fTestBuild
 
TList fAuxFiles
 
- Protected Member Functions inherited from Railway
const TStringMakeLibraryName (const TString &name)
 
TChainLocalChain ()
 
 Railway (const TUrl &url, Int_t verbose)
 
virtual Bool_t ParseOptions ()
 
virtual ~Railway ()
 
- Static Protected Member Functions inherited from Railway
static UShort_t DeduceType (const TString &str)
 
- Protected Attributes inherited from Railway
TUrl fUrl
 
OptionList fOptions
 
Int_t fVerbose
 

Detailed Description

Handle analysis on Proof-on-Demand

This helper is triggered by a URL of the form

proof://host/<datadir>[?<options>][#<treename>]

where <host&t; is a known AAF (e.g., alivafh)

<datadir>
Base directory to search for data
<pattern>
Filename pattern to search for. '' is a wild-card
<treename>
Optional tree name in data set, often esdTree or aodTree
<options>
List of options separated by an &
dsname[=<output dataset>]
Register tree output (e.g., AOD) as a new data set on the PROOF cluster. If <output dataset> is not specified, take the name of the train.
storage=<url>
Specify a non-default storage location for special output (e.g., AOD trees). <url> should be a valid XRootd server URI accessible to the slaves - e.g., root://lxplus.cern.ch:10930//tmp.
mode=[default,rec,sim,train,custom]
Set the AliROOT mode. If not specified default is assumed. See also CreateAliROOTPar
pattern=<file pattern>
The file name pattern to search for
par
Use par files

Note, this helper does not use the AliAnalysisAlien plugin

Definition at line 68 of file VAFRailway.C.

Constructor & Destructor Documentation

VAFRailway::VAFRailway ( const TUrl url,
Int_t  verbose 
)
inline

Constructor

Parameters
urlUrl
verboseVerbosity

Definition at line 76 of file VAFRailway.C.

virtual VAFRailway::~VAFRailway ( )
inlinevirtual

Definition at line 83 of file VAFRailway.C.

Member Function Documentation

virtual const char* VAFRailway::AliPhysicsParName ( ) const
inlinevirtual

Get the name of the Aliphysics par file to use

Returns
String

Reimplemented from ProofRailway.

Definition at line 119 of file VAFRailway.C.

virtual const char* VAFRailway::AliROOTParName ( ) const
inlinevirtual

Get the name of the AliROOT par file to use

Returns
String

Reimplemented from ProofRailway.

Definition at line 127 of file VAFRailway.C.

virtual Bool_t VAFRailway::Connect ( const TUrl url,
const TString opt 
)
inlinevirtual

Override base class to replace the proof protocol with pod.

Parameters
urlConnection URL
optPossible options
Returns
true on success

Reimplemented from ProofRailway.

Definition at line 190 of file VAFRailway.C.

virtual Bool_t VAFRailway::CreateAliPhysicsPar ( )
inlinevirtual

Reimplemented from ProofRailway.

Definition at line 120 of file VAFRailway.C.

virtual Bool_t VAFRailway::CreateAliROOTPar ( )
inlinevirtual

Create an AliROOT par file from the executing AliROOT. This PAR file basically uses the environment of the client - that is, we assume that the used AliROOT is accessible on the slaves - e.g., via an NFS export.

Note, the SETUP.C script take one argument - a TList of TNamed parameters. Parameters processed are

  • ALIROOT_MODE=[default,aliroot,rec,sim,train]
    • default: Load base analysis libraries
    • aliroot: Load $ALICE_ROOT/macros/loadlibs.C
    • rec: Load $ALICE_ROOT/macros/loadlibsrec.C
    • sim: Load $ALICE_ROOT/macros/loadlibssim.C
  • ALIROOT_EXTRA_LIBS Colon separated list of additional (Ali)ROOT libraries to load on the slaves.

The generated PAR file is uploaded but not enabled until we have populated fExtraLibs. The enabling takes place at the end of the set-up.

Returns
true on success, false otherwise.

Reimplemented from ProofRailway.

Definition at line 131 of file VAFRailway.C.

virtual const char* VAFRailway::Desc ( ) const
inlinevirtual
Returns
short description

Reimplemented from ProofRailway.

Definition at line 206 of file VAFRailway.C.

virtual Bool_t VAFRailway::EnableAliPhysics ( )
inlinevirtual

Enable the special AliROOT package on the cluster

Returns
true on success

Reimplemented from ProofRailway.

Definition at line 121 of file VAFRailway.C.

virtual void VAFRailway::GetDataSet ( TString dsName)
inlinevirtual

Get the data-set name. On VAF, this is a search description

Parameters
dsNameOn return, must contain the data set name

Reimplemented from ProofRailway.

Definition at line 164 of file VAFRailway.C.

virtual Bool_t VAFRailway::LoadAliROOT ( )
inlinevirtual

Do some sanity checks, then load

Returns
See ProofRailway::LoadAliROOT

Reimplemented from ProofRailway.

Definition at line 89 of file VAFRailway.C.

virtual Bool_t VAFRailway::PreSetup ( )
inlinevirtual

Set-up done before task set-ups. Overload ProofRailway::PreSetup to specify the ROOT version using TProofMgr::SetROOTVersion

Returns
true on success

Reimplemented from ProofRailway.

Definition at line 141 of file VAFRailway.C.

virtual const Char_t* VAFRailway::UrlHelp ( ) const
inlinevirtual
Returns
URI help string

Reimplemented from ProofRailway.

Definition at line 199 of file VAFRailway.C.


The documentation for this struct was generated from the following file: