Inheritance diagram for Railway:

[legend]

Public Types
enum	EMode { kLocal, kProof, kGrid }

enum	EOperation { kTest, kOffline, kSubmit, kTerminate, kFull }

enum	EInput { kESD, kAOD, kUser }

Public Member Functions
	Railway (const Railway &o)

Railway &	operator= (const Railway &)

Loading stuff
virtual void	UsePar (Bool_t &use)

virtual Bool_t	AddIncludePath (const TString &path)

virtual Bool_t	LoadLibrary (const TString &name, Bool_t slave=true, Bool_t forcePar=false)=0

virtual Bool_t	LoadSource (const TString &name, bool copy=false)

virtual Bool_t	LoadAux (const TString &name, Bool_t copy=false)

virtual Bool_t	LoadROOT ()

virtual Bool_t	LoadAliROOT ()

virtual Bool_t	LoadAliPhysics ()

Mode of exection
virtual UShort_t	Mode () const =0

virtual const char *	ModeString () const

virtual UShort_t	Operation () const

Processing
virtual Bool_t	PreSetup ()=0

virtual Bool_t	PostSetup ()=0

virtual Long64_t	Run (Long64_t nEvents=-1)=0

virtual Bool_t	AddMonitor (const TString &)

Static Public Member Functions
Create a railway
static Railway *	Create (const TUrl &url, Int_t verbose=0)

static Railway *	CreateObject (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
Loading things
const TString &	MakeLibraryName (const TString &name)

virtual Bool_t	AuxFile (TString &name, bool copy=false)

Static Protected Member Functions
Helper to figure out what we're doing
static UShort_t	DeduceType (const TString &str)

Protected Attributes
TUrl	fUrl

OptionList	fOptions

Int_t	fVerbose

Input/output
virtual Short_t	InputType () const

virtual Bool_t	IsMC () const

virtual TString	OutputPath () const

virtual TString	OutputLocation () const

TChain *	LocalChain ()

Various help functions
virtual void	Print (Option_t *="") const

virtual const Char_t *	UrlHelp () const =0

virtual const char *	Desc () const =0

const TUrl &	Url () const

const OptionList &	Options () const

virtual void	AuxSave (const TString &, Bool_t)

	Railway (const TUrl &url, Int_t verbose)

virtual Bool_t	ParseOptions ()

virtual	~Railway ()

Detailed Description

Helper class to set-up an analysis using a train

Definition at line 49 of file Railway.C.

Member Enumeration Documentation

enum Railway::EInput

Enumerator
kESD
kAOD
kUser

Definition at line 63 of file Railway.C.

enum Railway::EMode

Enumerator
kLocal
kProof
kGrid

Definition at line 51 of file Railway.C.

enum Railway::EOperation

Enumerator
kTest
kOffline
kSubmit
kTerminate
kFull

Definition at line 56 of file Railway.C.

Constructor & Destructor Documentation

Railway::Railway ( const Railway & o )

inline

Definition at line 68 of file Railway.C.

Railway::Railway	(	const TUrl &	url,
		Int_t	verbose
	)

inlineprotected

Constructor

Parameters

url	Set-up URL
verbose	Verbosity level

Definition at line 469 of file Railway.C.

virtual Railway::~Railway ( )

inlineprotectedvirtual

Destructor

Definition at line 484 of file Railway.C.

Member Function Documentation

virtual Bool_t Railway::AddIncludePath ( const TString & path )

inlinevirtual

Add an include path

Parameters

path	The path to add for header search

Returns: true on success

Reimplemented in ProofRailway, and PluginRailway.

Definition at line 201 of file Railway.C.

Referenced by PluginRailway::AddIncludePath(), and ProofRailway::AddIncludePath().

virtual Bool_t Railway::AddMonitor ( const TString & )

inlinevirtual

Add a monitor object - only for PROOF

Definition at line 419 of file Railway.C.

Referenced by ProofRailway::Run().

virtual Bool_t Railway::AuxFile	(	TString &	name,
		bool	copy = `false`
	)

inlineprotectedvirtual

Link an auxilary file to working directory

Parameters

name	Name of the file
copy	Copy rather than link

Returns: true on success

Reimplemented in ProofRailway, and GridRailway.

Definition at line 525 of file Railway.C.

Referenced by GridRailway::AuxFile(), ProofRailway::AuxFile(), LoadAux(), and LoadSource().

virtual void Railway::AuxSave	(	const TString &	,
		Bool_t
	)

inlinevirtual

Write auxillary ROOT (and possible shell) script for more (post-)processing e.g., terminate

Reimplemented in ProofRailway, and GridRailway.

Definition at line 460 of file Railway.C.

Referenced by TrainSetup::SaveSetup().

Railway * Railway::Create	(	const TUrl &	url,
		Int_t	verbose = `0`
	)

static

Create a helper object.

Parameters

verbose	Verbosity
url	Url describing the job.

Local mode:

local://<path>[#<treeName>][?[recursive[&]]]

<path> can be a single ROOT file, a text file with one entry per file to add to the chain, or a directory containing the files. If <path> does not start with a '/' then it is interpreted as a relative path.

Grid mode:

alien:///<path>#<pattern>

PROOF mode:

Several options

lite:

proof:///<path>[?[recursive[&]][workers=<n>]][#treeName]

proof://<host>/<dsname>[?[workers=<n>[&]][dsname[=<outname>]]][#treeName]

Note, if <host> is recognised as an Alice Analysis Facility, then the Grid handler (AliAnalysisAlien) is used unless the option plain was given.

Returns: Newly allocated helper or null

Definition at line 673 of file Railway.C.

Referenced by TrainSetup::Help(), TrainSetup::Init(), and operator=().

static Railway* Railway::CreateObject	(	const TString &	cl,
		const TUrl &	url,
		Int_t	verbose = `0`
	)

inlinestatic

Create an instance of a helper class

Definition at line 122 of file Railway.C.

Referenced by Create(), ShowFullHelp(), and ShowUrlHelp().

static UShort_t Railway::DeduceType ( const TString & str )

inlinestaticprotected

Deduce the top of job from a string

Parameters

str String

Returns: Job type

Definition at line 653 of file Railway.C.

Referenced by InputType().

virtual const char* Railway::Desc ( ) const

pure virtual

Returns: Short description string

Implemented in ProofRailway, GridRailway, PluginRailway, LiteRailway, VAFRailway, AAFPluginRailway, LocalRailway, and AAFRailway.

Referenced by TrainSetup::Help(), Print(), and ShowFullHelp().

virtual Short_t Railway::InputType ( ) const

inlinevirtual

Get the input data type

Returns: Input data type

Definition at line 338 of file Railway.C.

Referenced by TrainSetup::Init().

virtual Bool_t Railway::IsMC ( ) const

inlinevirtual

Check if the MC option was set

Returns: true if the MC option was given

Definition at line 354 of file Railway.C.

Referenced by TrackletdNdetaTrain::CoupleTrackletCar(), BothdNdetaTrain::CoupleTrackletCar(), TrackletAODdNdeta::CreateCentralitySelection(), MakedNdetaTrain::CreateTasks(), TrackletAODdNdeta::CreateTasks(), BothdNdetaTrain::CreateTasks(), TrainSetup::Init(), TrackletAODdNdeta::SaveCollect(), TrackletdNdetaTrain::SaveCollect(), BothdNdetaTrain::SaveCollect(), MakeAODTrain::SavedNdeta(), and BothAODTrain::SavedNdeta().

virtual Bool_t Railway::LoadAliPhysics ( )

inlinevirtual

Set-up to load the AliROOT libraries

Returns: true on success

Reimplemented in ProofRailway, and PluginRailway.

Definition at line 298 of file Railway.C.

Referenced by TrainSetup::Init().

virtual Bool_t Railway::LoadAliROOT ( )

inlinevirtual

Set-up to load the AliROOT libraries

Returns: true on success

Reimplemented in ProofRailway, PluginRailway, and VAFRailway.

Definition at line 279 of file Railway.C.

Referenced by TrainSetup::Init().

virtual Bool_t Railway::LoadAux	(	const TString &	name,
		Bool_t	copy = `false`
	)

inlinevirtual

Load auxillary file - not compiled or sourced. Just copied to working directory

Parameters

name	Extra file name
copy	Copy rather than link

Returns: true on success

Definition at line 255 of file Railway.C.

Referenced by TrainSetup::AddTender(), BothAODTrain::CoupleClusterCar(), BothAODTrain::CoupleForwardCar(), MakeFullTrain::CreateAODTasks(), TrainSetup::CreateCentralitySelection(), TrainSetup::CreatePhysicsSelection(), MakeTrackletTrain::CreateTask(), ELossTimeTrain::CreateTasks(), MakeQATrain::CreateTasks(), MakeFMDELossTrain::CreateTasks(), MakeAODTrain::CreateTasks(), AODTrain::CreateTasks(), TrackletdNdetaTrain::SetupReweighting(), and MakeTrackletTrain::SetupReweighting().

virtual Bool_t Railway::LoadLibrary	(	const TString &	name,
		Bool_t	slave = `true`,
		Bool_t	forcePar = `false`
	)

pure virtual

Load a library

Parameters

name	Name of library
slave	If true also load on slaves
forcePar	if true, force load as PAR

Returns: true on success, false otherwise

Implemented in ProofRailway, PluginRailway, and LocalRailway.

virtual Bool_t Railway::LoadROOT ( )

inlinevirtual

Load needed ROOT libaries

Definition at line 265 of file Railway.C.

Referenced by TrainSetup::Init().

virtual Bool_t Railway::LoadSource	(	const TString &	name,
		bool	copy = `false`
	)

inlinevirtual

Load a source file, and compile it

Parameters

name	Name of the source file
copy	Copy rather than link

Returns: true on success

Reimplemented in ProofRailway, and PluginRailway.

Definition at line 231 of file Railway.C.

Referenced by TrackletdNdetaTrain::CoupleTrackletCar(), TrackletAODTrain::CoupleTrackletCar(), BothdNdetaTrain::CoupleTrackletCar(), BothAODTrain::CoupleTrackletCar(), TrackletdNdetaTrain::CreateTask(), MakeTrackletTrain::CreateTask(), TrackletAODTrain::CreateTasks(), TrackletAODdNdeta::CreateTasks(), PluginRailway::LoadSource(), and ProofRailway::LoadSource().

TChain* Railway::LocalChain ( )

inlineprotected

Create a local chain based on URL and options

Returns: Chain or null

Definition at line 587 of file Railway.C.

Referenced by LiteRailway::PostSetup(), LocalRailway::PostSetup(), and ProofRailway::Run().

const TString& Railway::MakeLibraryName ( const TString & name )

inlineprotected

Normalize a library name

Parameters

name

Returns

Definition at line 498 of file Railway.C.

Referenced by LocalRailway::LoadLibrary(), PluginRailway::LoadLibrary(), and ProofRailway::LoadLibrary().

virtual UShort_t Railway::Mode ( ) const

pure virtual

Get the execution mode

Returns: Execution mode set in set-up URL

Implemented in ProofRailway, AAFPluginRailway, LocalRailway, and GridRailway.

Referenced by TrainSetup::AddMonitor(), MyTrain::CreateTasks(), EventTimeTrain::CreateTasks(), ELossTimeTrain::CreateTasks(), TrainSetup::Init(), LoadAliPhysics(), and MakeFMDMCTrackTrain::SaveSetup().

virtual const char* Railway::ModeString ( ) const

inlinevirtual

Get the mode string used for AliAnalysisManager::StartAnalysis

Reimplemented in ProofRailway, AAFPluginRailway, LocalRailway, and GridRailway.

Definition at line 321 of file Railway.C.

virtual UShort_t Railway::Operation ( ) const

inlinevirtual

Get the operation - this only makes sense for Grid jobs

Returns: Operation type

Reimplemented in GridRailway.

Definition at line 327 of file Railway.C.

Referenced by TrainSetup::SetupWorkingDirectory().

Railway& Railway::operator= ( const Railway & )

inline

Definition at line 71 of file Railway.C.

Referenced by LocalRailway::operator=(), PluginRailway::operator=(), and ProofRailway::operator=().

const OptionList& Railway::Options ( ) const

inline

Get the list of options

Returns: Reference to list of options

Definition at line 454 of file Railway.C.

Referenced by TrainSetup::Help(), MakeAODTrain::SavedNdeta(), BothAODTrain::SavedNdeta(), TrainSetup::SaveSetup(), and ShowFullHelp().

virtual TString Railway::OutputLocation ( ) const

inlinevirtual

Get the location of the output data. Use ful to define second pass scripts, etc.

Returns: Url string

Definition at line 369 of file Railway.C.

Referenced by MakeAODTrain::SavedNdeta(), and BothAODTrain::SavedNdeta().

virtual TString Railway::OutputPath ( ) const

inlinevirtual

The file part of tehe output URL - overwritten by derived classes.

Returns: File part of output URL

Reimplemented in ProofRailway, GridRailway, and LiteRailway.

Definition at line 361 of file Railway.C.

Referenced by OutputLocation(), and MakeFMDMCTrackTrain::SaveDownloadTrees().

virtual Bool_t Railway::ParseOptions ( )

inlineprotectedvirtual

Definition at line 476 of file Railway.C.

Referenced by Create().

virtual Bool_t Railway::PostSetup ( )

pure virtual

Set-up done after task setup

Returns: true on success

Implemented in ProofRailway, PluginRailway, GridRailway, AAFPluginRailway, LocalRailway, and LiteRailway.

Referenced by TrainSetup::Init(), and OutputLocation().

virtual Bool_t Railway::PreSetup ( )

pure virtual

Set-up done before task setup

Returns: true on success

Implemented in ProofRailway, GridRailway, PluginRailway, VAFRailway, LocalRailway, LiteRailway, AAFRailway, and AAFPluginRailway.

Referenced by TrainSetup::Init(), and OutputLocation().

virtual void Railway::Print ( Option_t * = "" ) const

inlinevirtual

Print information to standard output

Returns

Reimplemented in ProofRailway, and PluginRailway.

Definition at line 430 of file Railway.C.

Referenced by PluginRailway::Print(), TrainSetup::Print(), and ProofRailway::Print().

virtual Long64_t Railway::Run ( Long64_t nEvents = -1 )

pure virtual

Run the analysis

Parameters

nEvents Number of events to analyse

Returns: The return value of AliAnalysisManager::StartAnalysis

Implemented in ProofRailway, GridRailway, PluginRailway, AAFPluginRailway, LiteRailway, and LocalRailway.

Referenced by OutputLocation(), and TrainSetup::Run().

static void Railway::ShowFullHelp ( const TString & cl )

inlinestatic

Show help on URL and options using the interpreter

Parameters

cl	Railway class

Definition at line 163 of file Railway.C.

Referenced by Create().

static void Railway::ShowUrlHelp ( const TString & cl )

inlinestatic

Show help on URL using the interpreter

Parameters

cl	Railway class

Definition at line 151 of file Railway.C.

Referenced by Create(), and TrainSetup::Help().

const TUrl& Railway::Url ( ) const

inline

Get the input URL

Returns: Input URL

Definition at line 448 of file Railway.C.

virtual const Char_t* Railway::UrlHelp ( ) const

pure virtual

Returns: URL help string

Implemented in ProofRailway, GridRailway, PluginRailway, LiteRailway, VAFRailway, AAFPluginRailway, LocalRailway, and AAFRailway.

Referenced by TrainSetup::Help(), Print(), ShowFullHelp(), and ShowUrlHelp().

void Railway::UsePar ( Bool_t & use )

virtual

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

use	Whether to use pars or not. On return contains old value

Reimplemented in ProofRailway, and PluginRailway.

Definition at line 671 of file Railway.C.

Referenced by TrainSetup::LoadOADB(), and ShowFullHelp().

Member Data Documentation

OptionList Railway::fOptions

protected

Definition at line 663 of file Railway.C.

Referenced by AAFPluginRailway::AAFPluginRailway(), AAFRailway::AAFRailway(), GridRailway::AddFiles(), AAFRailway::AliPhysicsParName(), AAFRailway::AliROOTParName(), GridRailway::AuxSave(), ProofRailway::CreateAliROOTPar(), ProofRailway::EnableSpecial(), VAFRailway::GetDataSet(), GridRailway::GridRailway(), InputType(), IsMC(), LiteRailway::LiteRailway(), VAFRailway::LoadAliROOT(), LocalChain(), LocalRailway::LocalRailway(), GridRailway::Operation(), Options(), ProofRailway::OutputPath(), ParseOptions(), PluginRailway::PluginRailway(), AAFPluginRailway::PostSetup(), GridRailway::PostSetup(), PluginRailway::PostSetup(), ProofRailway::PostSetup(), AAFPluginRailway::PreSetup(), AAFRailway::PreSetup(), VAFRailway::PreSetup(), PluginRailway::PreSetup(), ProofRailway::PreSetup(), Print(), ProofRailway::ProofRailway(), Railway(), GridRailway::RegisterRuns(), LiteRailway::Run(), ProofRailway::Run(), GridRailway::ScanFiles(), and VAFRailway::VAFRailway().

TUrl Railway::fUrl

protected

Int_t Railway::fVerbose

protected

Definition at line 664 of file Railway.C.

Referenced by LocalChain(), LiteRailway::Run(), and ProofRailway::Run().

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

PWGLF/FORWARD/trains/Railway.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Input/output

Various help functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation