AliPhysics  9b6b435 (9b6b435)
PluginRailway Struct Referenceabstract
Inheritance diagram for PluginRailway:

Public Member Functions

 PluginRailway (const TUrl &url, Int_t verbose)
 
 PluginRailway (const PluginRailway &o)
 
PluginRailwayoperator= (const PluginRailway &o)
 
virtual ~PluginRailway ()
 
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=false)
 
virtual Bool_t LoadAliROOT ()
 
virtual Bool_t LoadAliPhysics ()
 
virtual Bool_t PreSetup ()
 
virtual Bool_t PostSetup ()
 
virtual Long64_t Run (Long64_t)=0
 
virtual const char * Desc () const =0
 
virtual const Char_tUrlHelp () const =0
 
virtual void Print (Option_t *option="") const
 
- 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 Mode () const =0
 
virtual const char * ModeString () const
 
virtual UShort_t Operation () const
 
virtual Bool_t AddMonitor (const TString &)
 
virtual Short_t InputType () const
 
virtual Bool_t IsMC () const
 
virtual TString OutputPath () const
 
virtual TString OutputLocation () const
 
const TUrlUrl () const
 
const OptionListOptions () const
 
virtual void AuxSave (const TString &, Bool_t)
 

Public Attributes

AliAnalysisAlienfHandler
 
Bool_t fUsePars
 
Bool_t fTestBuild
 
TList fExtraLibs
 
TList fExtraPars
 
TList fExtraSrcs
 

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 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)
 
- Protected Member Functions inherited from Railway
const TStringMakeLibraryName (const TString &name)
 
virtual Bool_t AuxFile (TString &name, bool copy=false)
 
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 using the AliAnalysisAlien plugin - i.e., AAF or Grid

This helper is triggered by a URL of the form

<protocol>://[<user>@][<host>][:<port>]/[<file>][?<options>][#<anchor>]

where <options> contains plugin

<options>
List of options separated by an &
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
par
Use par files
aliroot=<version>
Set AliROOT version to use
root=<version>
Set ROOT version to use

Definition at line 62 of file PluginRailway.C.

Constructor & Destructor Documentation

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

Constructor

Parameters
urlUrl
verboseVerbosity level

Definition at line 70 of file PluginRailway.C.

PluginRailway::PluginRailway ( const PluginRailway o)
inline

Copy constructor

Parameters
oObject to copy from

Definition at line 94 of file PluginRailway.C.

virtual PluginRailway::~PluginRailway ( )
inlinevirtual

Destructor

Definition at line 117 of file PluginRailway.C.

Member Function Documentation

virtual Bool_t PluginRailway::AddIncludePath ( const TString path)
inlinevirtual

Add an include path

Parameters
pathThe path to add for header search
Returns
true on success

Reimplemented from Railway.

Definition at line 144 of file PluginRailway.C.

virtual const char* PluginRailway::Desc ( ) const
pure virtual

Pure virtual overload

Returns
Short description

Implements Railway.

Implemented in GridRailway, and AAFPluginRailway.

Referenced by PostSetup().

virtual Bool_t PluginRailway::LoadAliPhysics ( )
inlinevirtual

Set-up to load the AliPHYSICS libraries

Returns
true on success

Reimplemented from Railway.

Definition at line 244 of file PluginRailway.C.

virtual Bool_t PluginRailway::LoadAliROOT ( )
inlinevirtual

Set-up to load the AliROOT libraries

Returns
true on success

Reimplemented from Railway.

Definition at line 221 of file PluginRailway.C.

virtual Bool_t PluginRailway::LoadLibrary ( const TString name,
Bool_t  slaves = true,
Bool_t  forcePar = false 
)
inlinevirtual

Load a library/PAR/script

Parameters
nameName
slavesIf true, also load on slaves
forceParif true, force load as PAR
Returns
true on success

Implements Railway.

Definition at line 164 of file PluginRailway.C.

Referenced by LoadAliROOT().

virtual Bool_t PluginRailway::LoadSource ( const TString name,
bool  copy = false 
)
inlinevirtual

Load a source file, and compile it

Parameters
nameName of the source file
copyIf true, copy here instead of link
Returns
true on success

Reimplemented from Railway.

Definition at line 206 of file PluginRailway.C.

PluginRailway& PluginRailway::operator= ( const PluginRailway o)
inline

Assignment operator

Parameters
oObject to assign from
Returns
Reference to this

Definition at line 105 of file PluginRailway.C.

Referenced by GridRailway::operator=().

virtual Bool_t PluginRailway::PostSetup ( )
inlinevirtual

Set-up done after the task set-ups

Returns
true on success

Implements Railway.

Reimplemented in GridRailway, and AAFPluginRailway.

Definition at line 305 of file PluginRailway.C.

Referenced by AAFPluginRailway::PostSetup(), and GridRailway::PostSetup().

virtual Bool_t PluginRailway::PreSetup ( )
inlinevirtual

Set-up done before task set-ups

Returns
true on success

Implements Railway.

Reimplemented in GridRailway, and AAFPluginRailway.

Definition at line 263 of file PluginRailway.C.

Referenced by AAFPluginRailway::PreSetup(), and GridRailway::PreSetup().

virtual void PluginRailway::Print ( Option_t option = "") const
inlinevirtual

Overload

Parameters
optionOptions

Reimplemented from Railway.

Definition at line 345 of file PluginRailway.C.

virtual Long64_t PluginRailway::Run ( Long64_t  )
pure virtual

Pure virtual overload

Returns

Implements Railway.

Implemented in GridRailway, and AAFPluginRailway.

Referenced by PostSetup().

virtual const Char_t* PluginRailway::UrlHelp ( ) const
pure virtual

Pure virtual overload

Returns
URI help string

Implements Railway.

Implemented in GridRailway, and AAFPluginRailway.

Referenced by PostSetup().

void PluginRailway::UsePar ( Bool_t use)
inlinevirtual

Set whether to use pars. On return, the argument is set to the old value. So to temporaruly turn off pars, do

Bool_t usePar = false;
fRailway->UsePar(usePar); // usePar is now old value
// Load real libraries
fRailway->UsePar(usePar); // Restore old value
Parameters
useWhether to use pars or not. On return contains old value

Reimplemented from Railway.

Definition at line 131 of file PluginRailway.C.

Member Data Documentation

TList PluginRailway::fExtraLibs

Definition at line 353 of file PluginRailway.C.

Referenced by GridRailway::AuxSave(), LoadLibrary(), and PluginRailway().

TList PluginRailway::fExtraPars

Definition at line 354 of file PluginRailway.C.

Referenced by GridRailway::AuxSave(), LoadLibrary(), and PluginRailway().

TList PluginRailway::fExtraSrcs

Definition at line 355 of file PluginRailway.C.

Referenced by GridRailway::AuxSave(), LoadSource(), and PluginRailway().

Bool_t PluginRailway::fTestBuild

Definition at line 352 of file PluginRailway.C.

Referenced by LoadLibrary(), operator=(), and PreSetup().

Bool_t PluginRailway::fUsePars

Definition at line 351 of file PluginRailway.C.

Referenced by LoadAliPhysics(), LoadAliROOT(), LoadLibrary(), operator=(), PreSetup(), and UsePar().


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