URANIE::Launcher::TLauncherByStep Class Reference

#include <TLauncherByStep.h>

Inheritance diagram for URANIE::Launcher::TLauncherByStep:

Collaboration diagram for URANIE::Launcher::TLauncherByStep:

Public Member Functions
Constructor and Destructor
	TLauncherByStep (URANIE::DataServer::TDataServer *tds, TCode *code, Option_t *option="")
	Default constructor.
virtual	~TLauncherByStep ()
	Default destructor.
Manipulate the code
virtual void	preTreatment (Option_t *option="")
	PreTreatment.
virtual void	run (Option_t *option="")
	Evaluate the code in each working subdirectory.
virtual void	postTreatment (Option_t *option="")
	PostTreatment.
Printing Log
virtual void	printLog (Option_t *option="")
	Print the log of the class.
Public Member Functions inherited from URANIE::Launcher::TLauncher
virtual void	createResultsDirectory (Option_t *option="")
	Builts Results directory, no available options.
URANIE::DataServer::TDSNtupleD *	createNtupleDFile (TString &sntlname, TString &slabelvarname, TString &slabelvartype)
	Create the ntupleD to store the output results.
void	initiateTheEntryVector ()
	Create fill correctly the UEntry vectors.
	TLauncher ()
	Default constructor.
	TLauncher (URANIE::DataServer::TDataServer *tds, TCode *code, Option_t *option="")
	Constructor with a dataserver.
virtual	~TLauncher ()
	Default destructor.
void	setWorkingDirectory (TString str)
	Sets the working directory where to realize the computations.
TString	getWorkingDirectory ()
	Gets the working directory.
void	setPreProCommand (TString sCommand)
	Set the \it "prepro" command to execute before each parallel computation.
TString	getPreProCommand ()
void	setPostProCommand (TString sCommand)
	Set the \it "postpro" command to execute after each parallel computation.
TString	getPostProCommand ()
void	setSave (Int_t nSave=-1)
	Activates the save mode and sets number of max saves to perform.
void	unsetSave ()
	Desactivates the save mode and unsets the specified number of max saves.
Bool_t	getSave ()
	Get the save flag.
void	setClean (Bool_t bbool=kTRUE)
	Set the clean flag.
Bool_t	getClean ()
	Get the clean flag.
void	setDrawProgressBar (Bool_t bbool=kTRUE)
	Set the "draw progress bar" flag.
Bool_t	getDrawProgressBar ()
	Get the clean flag.
Bool_t	getNoIntermediateSaved ()
	Get the clean flag.
void	addSaveFile (TString sfile)
	Defines the output file to save during the launching process.
void	setVarDraw (TString str, TString select="", TString opt="")
	Activates and defines the graphics during the launching.
void	setProcsPerJob (int procs)
int	getProcsPerJob ()
void	setDelay (int delay)
void	setLog ()
void	unsetLog ()
void	changeLog ()
Bool_t	getLog ()
void	setEmptyMasterNode ()
void	unsetEmptyMasterNode ()

manipulating variables for batch systems
Int_t	_nAllocatedSeconds
Int_t	_nAllocatedCores
TString	_sProjectName
TString	_sClusterName
vector< TString >	_sListExtraDirectives
void	setNumberOfCores (Int_t ncores)
	Sets the number of cores requested.
Int_t	getNumberOfCores () const
	Get the Number of cores allocated
void	setAllocatedTime (Int_t nseconds)
	Sets the requested time in seconds.
Int_t	getAllocatedTime () const
	Get the Number of second allocated.
void	setProjectName (TString project_name)
	Sets the project name.
TString	getProjectName () const
	Get the Project Name.
void	setClusterName (TString cluster_name)
	Sets the Cluster name.
TString	getClusterName () const
	Get the Cluster Name.
void	addExtraDirective (const TString &directive)
	Add extra directive.

Additional Inherited Members
Public Attributes inherited from URANIE::Launcher::TLauncher
TCode *	_code
TString	_sdraw
TString	_sopt
TString	_scut
TString	_sdirectory
	Current directory.
TString	_sworkingDirectory
	The Working directory.
TString	_sPreProCommand
	The prepro command before each parralel computation.
TString	_sPostProCommand
	The prepro command after each parralel computation.
TString	_sInputNames
TString	_sInputTypes
Bool_t	_bsave
	Saves all the computation files in each directory.
Bool_t	_bclean
	Cleans the Working Directory before runing the code.
Bool_t	_blog
	Boolean to edit the log.
Bool_t	_DoLogger
	Boolean to edit the log.
Bool_t	_DoMultiDump
	Boolean to edit the log.
Bool_t	_bdrawProgressBar
	Boolean to know if the progress bar has to be drawn.
Bool_t	_bnoIntermediateSaved
	Boolean to decide whether to keep or not the intermediate state.
Bool_t	_bemptyMasterNode
Int_t	_nprocs
	The number of process for one job.
Int_t	_nMaxSave
	The authorized number of saves.
Int_t	_delay
TList *	_listOfSaveFile
	temporisation in seconds between first and last execution on a batch system
URANIE::DataServer::TDataServer *	_tds
vector< URANIE::DataServer::UEntry * >	_InputVector
	Pointer vers un TDS.
vector< URANIE::DataServer::UEntry * >	_OutputVector
Protected Member Functions inherited from URANIE::Launcher::TLauncher
void	setNoIntermediateSaved (Bool_t bbool=kTRUE)
	Set the "only final file" flag.
virtual void	init (Option_t *option="")
	Init phase of the code.
virtual void	terminate (Option_t *option="")
	Terminate phase of the code.
virtual void	clean (Option_t *option="")
	Cleans the working directory of the code.
Protected Attributes inherited from URANIE::Launcher::TLauncher
URANIE::DataServer::UMessageLogger *	_fLogger

Constructor & Destructor Documentation

TLauncherByStep()

URANIE::Launcher::TLauncherByStep::TLauncherByStep	(	URANIE::DataServer::TDataServer *	tds,
		TCode *	code,
		Option_t *	option = ""
	)

Default constructor.

References URANIE::Launcher::TLauncher::setClean(), and URANIE::Launcher::TLauncher::setSave().

~TLauncherByStep()

URANIE::Launcher::TLauncherByStep::~TLauncherByStep ( )

virtual

Default destructor.

Member Function Documentation

addExtraDirective()

void URANIE::Launcher::TLauncherByStep::addExtraDirective ( const TString &  directive )

inline

Add extra directive.

Parameters

directive

(TString) extra directive

References _sListExtraDirectives.

getAllocatedTime()

Int_t URANIE::Launcher::TLauncherByStep::getAllocatedTime ( ) const

inline

Get the Number of second allocated.

Returns

Number of second allocated

References _nAllocatedSeconds.

getClusterName()

TString URANIE::Launcher::TLauncherByStep::getClusterName ( ) const

inline

Get the Cluster Name.

Returns

cluster Name

References _sClusterName.

getNumberOfCores()

Int_t URANIE::Launcher::TLauncherByStep::getNumberOfCores ( ) const

inline

Get the Number of cores allocated

Returns

Number of cores allocated

References _nAllocatedCores.

getProjectName()

TString URANIE::Launcher::TLauncherByStep::getProjectName ( ) const

inline

Get the Project Name.

Returns

project Name

References _sProjectName.

postTreatment()

void URANIE::Launcher::TLauncherByStep::postTreatment ( Option_t *  option = "" )

virtual

PostTreatment.

Extracts the values of the output attributes in the output files for each working subdirectory

References URANIE::Launcher::TLauncher::_bdrawProgressBar, URANIE::Launcher::TLauncher::_blog, URANIE::Launcher::TLauncher::_bnoIntermediateSaved, URANIE::Launcher::TLauncher::_code, URANIE::Launcher::TLauncher::_DoLogger, URANIE::Launcher::TLauncher::_InputVector, URANIE::Launcher::TLauncher::_listOfSaveFile, URANIE::Launcher::TLauncher::_OutputVector, URANIE::Launcher::TLauncher::_sdirectory, URANIE::Launcher::TLauncher::_sopt, URANIE::Launcher::TLauncher::_sworkingDirectory, URANIE::Launcher::TLauncher::_tds, URANIE::Launcher::TLauncher::createNtupleDFile(), URANIE::Launcher::TLauncher::getWorkingDirectory(), URANIE::Launcher::TCode::postTraitment(), URANIE::Launcher::TLauncher::setNoIntermediateSaved(), and URANIE::Launcher::TLauncher::terminate().

preTreatment()

void URANIE::Launcher::TLauncherByStep::preTreatment ( Option_t *  option = "" )

virtual

PreTreatment.

Creates all the working subdirectory which contains the input files

References URANIE::Launcher::TLauncher::_bdrawProgressBar, URANIE::Launcher::TLauncher::_blog, URANIE::Launcher::TLauncher::_bsave, URANIE::Launcher::TLauncher::_code, URANIE::Launcher::TLauncher::_DoLogger, URANIE::Launcher::TLauncher::_InputVector, URANIE::Launcher::TLauncher::_sdirectory, URANIE::Launcher::TLauncher::_tds, URANIE::Launcher::TLauncher::clean(), URANIE::Launcher::TCode::init(), URANIE::Launcher::TLauncher::init(), URANIE::Launcher::TLauncher::initiateTheEntryVector(), and URANIE::Launcher::TCode::preTraitment().

printLog()

void URANIE::Launcher::TLauncherByStep::printLog ( Option_t *  option = "" )

virtual

Print the log of the class.

Reimplemented from URANIE::Launcher::TLauncher.

run()

void URANIE::Launcher::TLauncherByStep::run ( Option_t *  option = "" )

virtual

Evaluate the code in each working subdirectory.

This step can be done by an another code

Reimplemented from URANIE::Launcher::TLauncher.

References URANIE::Launcher::TLauncher::_bdrawProgressBar, URANIE::Launcher::TLauncher::_blog, URANIE::Launcher::TLauncher::_code, URANIE::Launcher::TLauncher::_DoLogger, _nAllocatedCores, _nAllocatedSeconds, URANIE::Launcher::TLauncher::_nprocs, _sClusterName, URANIE::Launcher::TLauncher::_sdirectory, _sListExtraDirectives, _sProjectName, URANIE::Launcher::TLauncher::_sworkingDirectory, URANIE::Launcher::TLauncher::_tds, URANIE::Launcher::TCode::getCommand(), and URANIE::Launcher::TCode::run().

setAllocatedTime()

void URANIE::Launcher::TLauncherByStep::setAllocatedTime ( Int_t  nseconds )

inline

Sets the requested time in seconds.

Parameters

nseconds

(Int_t) number of second allocated

References _nAllocatedSeconds.

setClusterName()

void URANIE::Launcher::TLauncherByStep::setClusterName ( TString  cluster_name )

inline

Sets the Cluster name.

Parameters

cluster_name

(TString) name of the cluster

References _sClusterName.

setNumberOfCores()

void URANIE::Launcher::TLauncherByStep::setNumberOfCores ( Int_t  ncores )

inline

Sets the number of cores requested.

Parameters

ncores

(Int_t) number of cores requested

References _nAllocatedCores.

setProjectName()

void URANIE::Launcher::TLauncherByStep::setProjectName ( TString  project_name )

inline

Sets the project name.

Parameters

project_name

(TString) name of the project

References _sProjectName.

Member Data Documentation

_nAllocatedCores

Int_t URANIE::Launcher::TLauncherByStep::_nAllocatedCores

private

A private variable Contain the Number of cores allocated

Referenced by getNumberOfCores(), run(), and setNumberOfCores().

_nAllocatedSeconds

Int_t URANIE::Launcher::TLauncherByStep::_nAllocatedSeconds

private

A private variable Contain the Number of second allocated

Referenced by getAllocatedTime(), run(), and setAllocatedTime().

_sClusterName

TString URANIE::Launcher::TLauncherByStep::_sClusterName

private

A private variable Contain the Name of the Cluster

Referenced by getClusterName(), run(), and setClusterName().

_sListExtraDirectives

vector<TString> URANIE::Launcher::TLauncherByStep::_sListExtraDirectives

private

A private variable List of Extra Directives

Referenced by addExtraDirective(), and run().

_sProjectName

TString URANIE::Launcher::TLauncherByStep::_sProjectName

private

A private variable Contain the Name of the Project

Referenced by getProjectName(), run(), and setProjectName().