Detailed Description

Class piloting analyses of simulated data.

Created by KVClassFactory on Tue Feb 14 11:13:53 2017 Author: John Frankland,,,

Definition at line 19 of file KVSimDirAnalyser.h.

#include <KVSimDirAnalyser.h>

Inheritance diagram for KVSimDirAnalyser:

[legend]

Public Member Functions
	KVSimDirAnalyser ()
	Default constructor. More...

	~KVSimDirAnalyser ()

TString	ExpandAutoBatchName (const Char_t *format) const override
	Replace any special symbols in auto-format jobname with current values. More...

TTree *	GetAnalysedTree () const override

TString	GetAnalyserClassNameForBatchJob () override

auto &	GetFileList () const

Int_t	GetNumberOfFilesToAnalyse () const override

KVString	GetRootDirectoryOfDataToAnalyse () const override
	Returns path to data to be analysed. More...

Bool_t	ReadBatchEnvFile (const TString &) override

void	SetAuxFileList (const KVUnownedList &l) override

void	SetDataSetForFilter (const TString &f)

void	SetFileList (const KVUnownedList &l) override

void	SetSystemForFilter (const TString &f)

void	SubmitTask () override
	Set up and run the analysis. More...

void	WriteBatchEnvFile (const TString &, Bool_t sav=kTRUE) override

Public Member Functions inherited from KVDataAnalyser
	KVDataAnalyser ()
	Default constructor. More...

virtual	~KVDataAnalyser ()
	Default destructor. More...

virtual void	AddJobDescriptionList (TList *)

Bool_t	BatchMode () const

virtual Bool_t	CheckStatusUpdateInterval (Long64_t nevents) const

virtual Bool_t	CheckTaskVariables ()

void	ChooseNbEventToRead ()
	Ask user to set number of events to read. More...

void	ChooseRunningMode ()

void	ChooseUserClass ()
	Choose the user's analysis class. More...

void	DeleteBatchStatusFile () const
	Delete batch status file (and backup - '.bak') for batch job. More...

void	DoStatusUpdate (Long64_t nevents) const
	Print infos on events treated, disk usage, memory usage. More...

Bool_t	DoUserClassFilesExist ()

virtual KVDBRun *	GetAnalysedRun () const

virtual KVDBRunFile *	GetAnalysedRunFile () const

virtual KVDBSystem *	GetAnalysedSystem () const

KVDataAnalysisTask *	GetAnalysisTask () const

const Char_t *	GetBatchName ()

const Char_t *	GetBatchStatusFileName () const
	Returns full path to file used to store status of running batch jobs. More...

virtual const KVBatchSystem *	GetBatchSystem ()

const KVString &	GetDataType () const

virtual const KV2Body *	GetKinematics () const

const Char_t *	GetLaunchDirectory () const

Long64_t	GetNbEventToRead (void) const

KVDataAnalyser *	GetParent () const

TString	GetPathToFileInLaunchDirectory (const TString &) const

EProofMode	GetProofMode () const

virtual const Char_t *	GetRecognisedAutoBatchNameKeywords () const

Double_t	GetStatusUpdateInterval () const

virtual Long64_t	GetTotalEntriesToRead () const

const UserClass &	GetUserClass () const

KVString	GetUserClassName ()

const KVString &	GetUserClassOptions () const

const KVString &	GetUserIncludes () const

const KVString &	GetUserLibraries () const

Bool_t	IsMenus () const

Bool_t	IsQuit () const

Bool_t	IsSubmit () const

Bool_t	IsUserClassValid () const

virtual void	postAnalysis ()

virtual void	postEndAnalysis ()

virtual void	postEndRun ()

virtual void	postInitAnalysis ()

virtual void	postInitRun ()

virtual void	preAnalysis ()

virtual void	preEndAnalysis ()

virtual void	preEndRun ()

virtual void	preInitAnalysis ()

virtual void	preInitRun ()

virtual void	RegisterUserClass (TObject *)

virtual void	Reset ()

virtual void	Run ()
	Check all task variables, then run analyser. More...

virtual void	RunMenus ()
	Run data analyser in menu-driven mode. More...

Bool_t	RunningInLaunchDirectory ()

virtual void	SetAnalysedTree (TTree *)

void	SetAnalysisTask (KVDataAnalysisTask *at)

void	SetBatchMode (Bool_t on=kTRUE)

void	SetBatchName (const Char_t *batchname)

void	SetBatchSystem (KVBatchSystem *bs)

void	SetDataType (const Char_t *name)

void	SetMenus (Bool_t on=kTRUE)

void	SetNbEventToRead (Long64_t nb=0)

void	SetParent (KVDataAnalyser *da)

void	SetProofMode (EProofMode e)

void	SetQuit (Bool_t yes=kTRUE)

void	SetStatusUpdateInterval (double t)

void	SetSubmit (Bool_t yes=kTRUE)

virtual void	SetTriggerConditionsForRun (int)

void	SetUserClass (const UserClass &kvs, Bool_t check=kTRUE)

void	SetUserClassOptions (const Char_t *o="")

void	SetUserIncludes (const Char_t *incDirs=0)

void	SetUserLibraries (const Char_t *libs=0)

void	UpdateBatchStatusFile (Int_t totev, Int_t evread, TString disk) const
	Update infos in batch status file. More...

void	UseBaseClassSubmitTask ()

void	WriteBatchInfo (TTree *)

Static Public Member Functions
static void	Make (const Char_t *kvsname="MySimulatedAnalysis")
	Generate a new simulated analysis selector class. More...

Static Public Member Functions inherited from KVDataAnalyser
static Bool_t	AbortProcessingLoop ()

static KVDataAnalyser *	GetAnalyser (const Char_t *plugin)

static Bool_t	IsRunningBatchAnalysis ()

static void	RunAnalyser (const Char_t *plugin="")

static void	SetAbortProcessingLoop (Bool_t now=kTRUE)

Additional Inherited Members
Public Types inherited from KVDataAnalyser
enum	EProofMode { None , Lite , Proof }

Constructor & Destructor Documentation

◆ KVSimDirAnalyser()

KVSimDirAnalyser::KVSimDirAnalyser ( )

Default constructor.

Definition at line 18 of file KVSimDirAnalyser.cpp.

◆ ~KVSimDirAnalyser()

KVSimDirAnalyser::~KVSimDirAnalyser ( )

inline

Destructor

Definition at line 43 of file KVSimDirAnalyser.h.

Member Function Documentation

◆ ExpandAutoBatchName()

TString KVSimDirAnalyser::ExpandAutoBatchName ( const Char_t * format ) const

overridevirtual

Replace any special symbols in auto-format jobname with current values.

Reimplemented from KVDataAnalyser.

Definition at line 288 of file KVSimDirAnalyser.cpp.

◆ GetAnalysedTree()

TTree* KVSimDirAnalyser::GetAnalysedTree ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 86 of file KVSimDirAnalyser.h.

◆ GetAnalyserClassNameForBatchJob()

TString KVSimDirAnalyser::GetAnalyserClassNameForBatchJob ( )

inlineoverridevirtual

value used to set KVANALYSER shell variable used for setting up & running batch jobs

Returns: name of KVDataAnalyser plugin to use. For all analysers derived from KVSimDirAnalyser, it is "SimDirAnalyser"

Reimplemented from KVDataAnalyser.

Definition at line 90 of file KVSimDirAnalyser.h.

◆ GetFileList()

auto& KVSimDirAnalyser::GetFileList ( ) const

inline

Definition at line 58 of file KVSimDirAnalyser.h.

◆ GetNumberOfFilesToAnalyse()

Int_t KVSimDirAnalyser::GetNumberOfFilesToAnalyse ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 62 of file KVSimDirAnalyser.h.

◆ GetRootDirectoryOfDataToAnalyse()

KVString KVSimDirAnalyser::GetRootDirectoryOfDataToAnalyse ( ) const

overridevirtual

Returns path to data to be analysed.

Reimplemented from KVDataAnalyser.

Definition at line 109 of file KVSimDirAnalyser.cpp.

◆ Make()

void KVSimDirAnalyser::Make ( const Char_t * kvsname = "MySimulatedAnalysis" )

static

Generate a new simulated analysis selector class.

Definition at line 266 of file KVSimDirAnalyser.cpp.

◆ ReadBatchEnvFile()

Bool_t KVSimDirAnalyser::ReadBatchEnvFile ( const TString & filename )

overridevirtual

Read the batch env file "filename" and initialise the analysis task using the informations in the file Returns kTRUE if all goes well

Reimplemented from KVDataAnalyser.

Definition at line 168 of file KVSimDirAnalyser.cpp.

◆ SetAuxFileList()

void KVSimDirAnalyser::SetAuxFileList ( const KVUnownedList & l )

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 54 of file KVSimDirAnalyser.h.

◆ SetDataSetForFilter()

void KVSimDirAnalyser::SetDataSetForFilter ( const TString & f )

inline

Definition at line 76 of file KVSimDirAnalyser.h.

◆ SetFileList()

void KVSimDirAnalyser::SetFileList ( const KVUnownedList & l )

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 49 of file KVSimDirAnalyser.h.

◆ SetSystemForFilter()

void KVSimDirAnalyser::SetSystemForFilter ( const TString & f )

inline

Definition at line 81 of file KVSimDirAnalyser.h.

◆ SubmitTask()

void KVSimDirAnalyser::SubmitTask ( )

overridevirtual

Set up and run the analysis.

Reimplemented from KVDataAnalyser.

Definition at line 29 of file KVSimDirAnalyser.cpp.

◆ WriteBatchEnvFile()

void KVSimDirAnalyser::WriteBatchEnvFile	(	const TString &	jobname,
		Bool_t	sav = `kTRUE`
	)

overridevirtual

Save (in the TEnv fBatchEnv) all necessary information on analysis task which can be used to execute it later (i.e. when batch processing system executes the job). If save=kTRUE (default), write the information in a file whose name is given by ".jobname" where 'jobname' is the name of the job as given to the batch system.

Reimplemented from KVDataAnalyser.

Definition at line 127 of file KVSimDirAnalyser.cpp.

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVSimDirAnalyser()

◆ ~KVSimDirAnalyser()

Member Function Documentation

◆ ExpandAutoBatchName()

◆ GetAnalysedTree()

◆ GetAnalyserClassNameForBatchJob()

◆ GetFileList()

◆ GetNumberOfFilesToAnalyse()

◆ GetRootDirectoryOfDataToAnalyse()

◆ Make()

◆ ReadBatchEnvFile()

◆ SetAuxFileList()

◆ SetDataSetForFilter()

◆ SetFileList()

◆ SetSystemForFilter()

◆ SubmitTask()

◆ WriteBatchEnvFile()