Project
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
FairRun Class Referenceabstract

#include <FairRun.h>

Inherits TNamed.

Inherited by FairRunSim.

Public Member Functions

 FairRun (Bool_t isMaster=kTRUE)
 
virtual ~FairRun ()
 
virtual void AddTask (FairTask *t)
 
virtual void StoreTaskNames (const FairTask *t)
 
virtual void SetTask (FairTask *t)
 
virtual void Init ()=0
 
virtual FairField * GetField ()=0
 
virtual void Run (Int_t NStart=0, Int_t NStop=0)=0
 
void SetEventHeader (FairEventHeader *EvHeader)
 
void SetSink (FairSink *tempSink)
 
FairSink * GetSink ()
 
Int_t GetRunId ()
 
void SetRunId (UInt_t runId)
 
FairEventHeader * GetEventHeader ()
 
Bool_t IsAna ()
 
FairTask * GetTask (const char *taskName)
 
FairTask * GetMainTask ()
 
Int_t GetNTasks ()
 
void CreateGeometryFile (const char *geofile)
 
void SetWriteRunInfoFile (Bool_t write)
 
void SetGenerateRunInfo (Bool_t write)
 
Bool_t GetWriteRunInfoFile ()
 
Bool_t IsRunInfoGenerated ()
 
void SetUseFairLinks (Bool_t val)
 
Bool_t GetIsMaster () const
 
void MarkFill (Bool_t flag)
 
TString GetOptions ()
 
void SetOptions (const TString &s)
 
virtual void SetOutputFile (const char *fname)
 
virtual void SetOutputFile (TFile *f)
 
void SetOutputFileName (const TString &name)
 
TFile * GetOutputFile ()
 
void SetUserOutputFileName (const TString &name)
 
TString GetUserOutputFileName () const
 
void AddAlignmentMatrices (const std::map< std::string, TGeoHMatrix > &alignmentMatrices, bool invertMatrices=false)
 

Static Public Member Functions

static FairRun * Instance ()
 

Protected Member Functions

void AlignGeometry () const
 
 ClassDef (FairRun, 5)
 

Protected Attributes

FairTask * fTask
 
FairRootManager * fRootManager
 
FairSink * fSink
 
TString fUserOutputFileName
 
TString fOptions
 
UInt_t fRunId
 
Bool_t fAna
 
FairEventHeader * fEvtHeader
 
FairFileHeader * fFileHeader
 
Bool_t fGenerateRunInfo
 
Bool_t fIsMaster
 
Bool_t fMarkFill
 
FairAlignmentHandler fAlignmentHandler
 

Static Protected Attributes

static TMCThreadLocal FairRun * fRunInstance = 0
 

Friends

class FairMCApplication
 

Detailed Description

Configure the Simuation or Analysis

Author
M. Al-Turany D. Bertini
Version
0.1
Since
12.01.04

Definition at line 37 of file FairRun.h.

Constructor & Destructor Documentation

◆ FairRun()

FairRun::FairRun ( Bool_t  isMaster = kTRUE)

default ctor

Definition at line 33 of file FairRun.cxx.

◆ ~FairRun()

FairRun::~FairRun ( )
virtual

default dtor

Definition at line 59 of file FairRun.cxx.

Member Function Documentation

◆ AddAlignmentMatrices()

void FairRun::AddAlignmentMatrices ( const std::map< std::string, TGeoHMatrix > &  alignmentMatrices,
bool  invertMatrices = false 
)

Definition at line 181 of file FairRun.cxx.

◆ AddTask()

void FairRun::AddTask ( FairTask *  t)
virtual

Add a FAIRTask to the simulation or analysis

Definition at line 68 of file FairRun.cxx.

◆ AlignGeometry()

void FairRun::AlignGeometry ( ) const
protected

Definition at line 179 of file FairRun.cxx.

◆ ClassDef()

FairRun::ClassDef ( FairRun  ,
5   
)
protected

◆ CreateGeometryFile()

void FairRun::CreateGeometryFile ( const char *  geofile)

Create a new file and save the TGeoManager to it

Definition at line 101 of file FairRun.cxx.

◆ GetEventHeader()

FairEventHeader * FairRun::GetEventHeader ( )

Get the detector specific run header

Definition at line 110 of file FairRun.cxx.

◆ GetField()

virtual FairField * FairRun::GetField ( )
pure virtual

Implemented in FairRunSim.

◆ GetIsMaster()

Bool_t FairRun::GetIsMaster ( ) const
inline

Definition at line 142 of file FairRun.h.

◆ GetMainTask()

FairTask * FairRun::GetMainTask ( )
inline

Get Main Task

Definition at line 117 of file FairRun.h.

◆ GetNTasks()

Int_t FairRun::GetNTasks ( )
inline

Return the number of Tasks added to this Run

Definition at line 121 of file FairRun.h.

◆ GetOptions()

TString FairRun::GetOptions ( )
inline

Definition at line 148 of file FairRun.h.

◆ GetOutputFile()

TFile * FairRun::GetOutputFile ( )

Definition at line 166 of file FairRun.cxx.

◆ GetRunId()

Int_t FairRun::GetRunId ( )
inline

return the run ID for the actul run

Definition at line 96 of file FairRun.h.

◆ GetSink()

FairSink * FairRun::GetSink ( )
inline

return a pointer to the sink

Definition at line 92 of file FairRun.h.

◆ GetTask()

FairTask * FairRun::GetTask ( const char *  taskName)

Get task by name

Definition at line 103 of file FairRun.cxx.

◆ GetUserOutputFileName()

TString FairRun::GetUserOutputFileName ( ) const

Definition at line 177 of file FairRun.cxx.

◆ GetWriteRunInfoFile()

Bool_t FairRun::GetWriteRunInfoFile ( )

Definition at line 129 of file FairRun.cxx.

◆ Init()

virtual void FairRun::Init ( )
pure virtual

Initialize the Simulation or analysis

Implemented in FairRunSim, and o2::steer::O2RunSim.

◆ Instance()

FairRun * FairRun::Instance ( )
static

static instance

Definition at line 31 of file FairRun.cxx.

◆ IsAna()

Bool_t FairRun::IsAna ( )
inline

return true for Anaylsis session

Definition at line 108 of file FairRun.h.

◆ IsRunInfoGenerated()

Bool_t FairRun::IsRunInfoGenerated ( )
inline

Definition at line 136 of file FairRun.h.

◆ MarkFill()

void FairRun::MarkFill ( Bool_t  flag)
inline

Definition at line 145 of file FairRun.h.

◆ Run()

virtual void FairRun::Run ( Int_t  NStart = 0,
Int_t  NStop = 0 
)
pure virtual

run the analysis or simulation

Implemented in FairRunSim.

◆ SetEventHeader()

void FairRun::SetEventHeader ( FairEventHeader *  EvHeader)
inline

Set the experiment dependent run header for each run

Definition at line 76 of file FairRun.h.

◆ SetGenerateRunInfo()

void FairRun::SetGenerateRunInfo ( Bool_t  write)
inline

Definition at line 130 of file FairRun.h.

◆ SetOptions()

void FairRun::SetOptions ( const TString &  s)
inline

Definition at line 151 of file FairRun.h.

◆ SetOutputFile() [1/2]

void FairRun::SetOutputFile ( const char *  fname)
virtual

Set the output file name for analysis or simulation

Definition at line 138 of file FairRun.cxx.

◆ SetOutputFile() [2/2]

void FairRun::SetOutputFile ( TFile *  f)
virtual

Set the output file for analysis or simulation

Definition at line 147 of file FairRun.cxx.

◆ SetOutputFileName()

void FairRun::SetOutputFileName ( const TString &  name)

Set the output file name without creating the file

Definition at line 157 of file FairRun.cxx.

◆ SetRunId()

void FairRun::SetRunId ( UInt_t  runId)
inline

Set the Run ID

Definition at line 101 of file FairRun.h.

◆ SetSink()

void FairRun::SetSink ( FairSink *  tempSink)
inline

return a pointer to the RuntimeDB Set the sink

Definition at line 83 of file FairRun.h.

◆ SetTask()

void FairRun::SetTask ( FairTask *  t)
virtual

Definition at line 89 of file FairRun.cxx.

◆ SetUseFairLinks()

void FairRun::SetUseFairLinks ( Bool_t  val)

Definition at line 118 of file FairRun.cxx.

◆ SetUserOutputFileName()

void FairRun::SetUserOutputFileName ( const TString &  name)

New functions which allow to postpone creating a new Sink in MT to be kept after clean-up of deprecated functions above

Definition at line 175 of file FairRun.cxx.

◆ SetWriteRunInfoFile()

void FairRun::SetWriteRunInfoFile ( Bool_t  write)

Definition at line 120 of file FairRun.cxx.

◆ StoreTaskNames()

void FairRun::StoreTaskNames ( const FairTask *  t)
virtual

Definition at line 74 of file FairRun.cxx.

Friends And Related Symbol Documentation

◆ FairMCApplication

friend class FairMCApplication
friend

Definition at line 39 of file FairRun.h.

Member Data Documentation

◆ fAlignmentHandler

FairAlignmentHandler FairRun::fAlignmentHandler
protected

Definition at line 213 of file FairRun.h.

◆ fAna

Bool_t FairRun::fAna
protected

true for Anaylsis session

Definition at line 201 of file FairRun.h.

◆ fEvtHeader

FairEventHeader* FairRun::fEvtHeader
protected

MC Event Header

Definition at line 203 of file FairRun.h.

◆ fFileHeader

FairFileHeader* FairRun::fFileHeader
protected

File Header

Definition at line 205 of file FairRun.h.

◆ fGenerateRunInfo

Bool_t FairRun::fGenerateRunInfo
protected

true if RunInfo file should be written

Definition at line 207 of file FairRun.h.

◆ fIsMaster

Bool_t FairRun::fIsMaster
protected

true if on master

Definition at line 209 of file FairRun.h.

◆ fMarkFill

Bool_t FairRun::fMarkFill
protected

Definition at line 211 of file FairRun.h.

◆ fOptions

TString FairRun::fOptions
protected

Options for derived classes, to be set & parsed by user

Definition at line 197 of file FairRun.h.

◆ fRootManager

FairRootManager* FairRun::fRootManager
protected

IO manager

Definition at line 191 of file FairRun.h.

◆ fRunId

UInt_t FairRun::fRunId
protected

Run Id

Definition at line 199 of file FairRun.h.

◆ fRunInstance

TMCThreadLocal FairRun * FairRun::fRunInstance = 0
staticprotected

static pointer to this run

Definition at line 186 of file FairRun.h.

◆ fSink

FairSink* FairRun::fSink
protected

Output sink

Definition at line 193 of file FairRun.h.

◆ fTask

FairTask* FairRun::fTask
protected

RuntimeDb Tasks used

Definition at line 189 of file FairRun.h.

◆ fUserOutputFileName

TString FairRun::fUserOutputFileName
protected

Output file name set by user

Definition at line 195 of file FairRun.h.

The documentation for this class was generated from the following files: