StarGenEventReader Class Reference

Inheritance diagram for StarGenEventReader:

Public Member Functions
	StarGenEventReader (const Char_t *name="vmcreader")
Int_t	Init ()
Int_t	Generate ()
Public Member Functions inherited from StarGenerator
	StarGenerator (const Char_t *name="")
Int_t	InitRun (Int_t runnumber)
	Developer may not provide run initialization.
virtual Int_t	PreGenerate ()
	Developers may provide a pre-generate method which will execute before Generate().
virtual Int_t	PostGenerate ()
	Developers may provide a post-generate method which will execute after Generate().
virtual void	FillPP (StarGenEvent *event)
	(Optional) Method to fill a PP event
virtual void	FillAA (StarGenEvent *event)
	(Optional) Method to fill a AA event
virtual void	FillEP (StarGenEvent *event)
	(Optional) Method to fill a DIS event
virtual void	FillEA (StarGenEvent *event)
	(Optional) Method to fill a eA event
virtual void	FillUser (StarGenEvent *event)
	(Optional) Method to fill a user-defined event
Int_t	PreGenerateHook ()
Int_t	PostGenerateHook ()
Int_t	Make ()
	If called, make simply aliases to the Generate() function.
void	Clear (const Option_t *opts="")
	Clear the event.
Int_t	Finalize ()
void	SetBlue (const Char_t *b)
	Sets the particle species for the blue beam.
void	SetYell (const Char_t *y)
	Sets the particle species for the yellow beam.
void	SetFrame (const Char_t *frame, const Double_t val)
void	SetFrame (const Char_t *frame, const Double_t *pblue, const Double_t *pyell)
void	SetImpact (Double_t bmin, Double_t bmax)
	Set the minimum and maximum impact parameters for the collision (HI generators)
Int_t	GetNumberOfParticles ()
	Returns the number of particles in the event.
void	SetPileup (Bool_t p, Double_t prob=0.10)
Bool_t	IsPileup ()
	Returns true if this is a pileup generator.
Double_t	GetPileup ()
	Returns the pileup probability.
void	SetOutputTree (TTree *tree)
void	SetInputTree (TTree *tree, const Char_t *bname=0)
void	SetInputFile (const Char_t *name, const Char_t *treename="genevents", const Char_t *bname=0)
Int_t	IOmode ()
	Returns the ID of this event generator.
StarGenEvent *	Event ()
	Retrieves the event record.
virtual StarGenStats	Stats ()
	Create and retrieve end-of-run statistics.
virtual const char *	GetCVS () const
Public Member Functions inherited from StMaker
	StMaker (const char *name="", const char *dummy=0)
	Constructor & Destructor.
virtual Int_t	IsChain () const
virtual void	Clear (Option_t *option="")
	User defined functions.
virtual void	StartMaker ()
virtual Int_t	IMake (Int_t number)
virtual void	EndMaker (Int_t ierr)
virtual Int_t	Finish ()
virtual Int_t	FinishRun (Int_t oldrunumber)
virtual void	FatalErr (Int_t Ierr, const char *Com)
virtual void	PrintInfo ()
virtual void	NotifyMe (const char *, const void *)
virtual void	AddMaker (StMaker *mk)
virtual void	MakeDoc (const TString &, const TString &, Bool_t)
virtual void	AddData (TDataSet *data, const char *dir=".data")
	User methods.
virtual TDataSet *	AddObj (TObject *obj, const char *dir, int owner=1)
virtual TDataSet *	ToWhiteBoard (const char *name, void *dat)
virtual TDataSet *	ToWhiteBoard (const char *name, void *dat, void *del)
virtual TDataSet *	ToWhiteBoard (const char *name, TObject *dat, Int_t owner)
virtual TDataSet *	ToWhiteConst (const char *name, TObject *dat)
virtual TDataSet *	ToWhiteConst (const char *name, void *dat)
virtual TDataSet *	WhiteBoard (const char *name, void *v=0) const
virtual Int_t	Skip (Int_t nskip)
virtual void	AddConst (TDataSet *data=0)
virtual void	AddHist (TH1 *h, const char *dir=0)
virtual void	AddGarb (TDataSet *data=0)
virtual void	AddRunco (TDataSet *data=0)
virtual void	AddRunco (Double_t par, const char *name, const char *comment)
void	AddRunCont (TDataSet *data=0)
virtual TList *	GetHistList () const
virtual TH1 *	GetHist (const char *histName) const
virtual StMaker *	cd ()
virtual StMaker *	Cd ()
virtual Int_t	GetNumber () const
	STAR methods.
virtual void	SetNumber (Int_t number)
virtual StMaker *	GetParentChain () const
virtual Int_t	GetIventNumber () const
	Returns the current event number.
virtual void	SetIventNumber (Int_t iv)
virtual Int_t	GetEventNumber () const
virtual Int_t	GetRunNumber () const
	Returns the current RunNumber.
virtual const TDatime &	GetDateTime () const
virtual const TDatime &	GetDBTime () const
virtual void	SetDateTime (Int_t idat, Int_t itim)
virtual StEvtHddr *	GetEvtHddr () const
virtual Int_t	GetDate () const
virtual Int_t	GetTime () const
virtual const char *	GetEventType () const
virtual TDataSet *	GetData (const char *name, const char *dir=".data") const
virtual TDataSet *	GetData () const
virtual TDataSet *	GetConst () const
virtual TDataSet *	GetDataSet (const char *logInput) const
virtual TDataSet *	DataSet (const char *logInput) const
virtual TDataSet *	GetInputDS (const char *logInput) const
virtual TDataSet *	GetDataBase (const char *logInput, const TDatime *td=0)
virtual TDataSet *	GetInputDB (const char *logInput)
virtual Int_t	GetDebug () const
virtual Int_t	Debug () const
virtual Int_t	GetMakeReturn () const
virtual TList *	Histograms () const
virtual TString	GetAlias (const char *log, const char *dir=".aliases") const
virtual TString	GetInput (const char *log) const
virtual TString	GetOutput (const char *log) const
virtual TList *	GetMakeList () const
virtual StMaker *	GetParentMaker () const
virtual StMaker *	GetMaker (const char *mkname)
virtual StMaker *	GetMakerInheritsFrom (const char *mktype) const
virtual Bool_t	IsActive ()
virtual StMaker *	Maker (const char *mkname)
virtual void	SetBIT (EMakerStatus k)
	Maker Status Bits.
virtual void	ResetBIT (EMakerStatus k)
virtual Bool_t	TestBIT (EMakerStatus k)
virtual void	SetActive (Bool_t k=kTRUE)
	Setters for flags and switches.
virtual void	SetDebug (Int_t l=1)
virtual void	SetDEBUG (Int_t l=1)
virtual void	SetFlavor (const char *flav, const char *tabname)
virtual void	SetMakeReturn (Int_t ret)
virtual void	SetAlias (const char *log, const char *act, const char *dir=".aliases")
virtual void	AddAlias (const char *log, const char *act, const char *dir=".aliases")
virtual void	SetInput (const char *log, const char *act)
virtual void	SetOutput (const char *log, const char *act)
virtual void	SetOutput (const char *log, TDataSet *ds)
virtual void	SetOutput (TDataSet *ds)
virtual void	SetOutputAll (TDataSet *ds, Int_t level=1)
virtual void	SetMode (Int_t mode=0)
virtual void	SetNotify (const char *about, StMaker *mk)
virtual Int_t	GetMode ()
virtual Int_t	GetDebug ()
virtual const StChainOpt *	GetChainOpt () const
virtual TFile *	GetTFile () const
virtual void	NotifyEm (const char *about, const void *ptr)
virtual Double_t	RealTime ()
virtual Double_t	CpuTime ()
virtual void	StartTimer (Bool_t reset=kFALSE)
virtual void	StopTimer ()
virtual void	PrintTimer (Option_t *option="")
virtual void	PrintTotalTime ()
virtual const char *	GetName () const
	special overload
TObject *	GetDirObj (const char *dir) const
void	SetDirObj (TObject *obj, const char *dir)
Int_t	SetAttr (const char *key, const char *val, const char *to=".")
Int_t	SetAttr (const char *key, Int_t val, const char *to=".")
Int_t	SetAttr (const char *key, UInt_t val, const char *to=".")
Int_t	SetAttr (const char *key, Double_t val, const char *to=".")
Int_t	SetAttr (const StMaker *mk)
Int_t	RemAttr (const char *key, const char *to=".")
const TAttr *	GetAttr () const
Int_t	IAttr (const char *key) const
UInt_t	UAttr (const char *key) const
Double_t	DAttr (const char *key) const
const char *	SAttr (const char *key) const
void	PrintAttr () const
Public Member Functions inherited from TDataSet
	TDataSet (const char *name="", TDataSet *parent=0, Bool_t arrayFlag=kFALSE)
	TDataSet (const TDataSet &src, EDataSetPass iopt=kAll)
	TDataSet (TNode &src)
	This copy ctor has been depricated (left for thwe sake of the backweard compatibility)
virtual	~TDataSet ()
	std::cout << "Default destructor for " << GetName() << " - " << GetTitle() << std::endl;
virtual void	Add (TDataSet *dataset)
virtual void	AddAt (TDataSet *dataset, Int_t idx=0)
virtual void	AddAtAndExpand (TDataSet *dataset, Int_t idx=0)
virtual void	AddFirst (TDataSet *dataset)
	Add TDataSet object at the beginning of the dataset list of this dataset.
virtual void	AddLast (TDataSet *dataset)
	Add TDataSet object at the end of the dataset list of this dataset.
TDataSet *	At (Int_t idx) const
virtual void	Browse (TBrowser *b)
	Browse this dataset (called by TBrowser).
virtual TObject *	Clone (const char *newname="") const
	the custom implementation fo the TObject::Clone
virtual void	Delete (Option_t *opt="")
virtual TDataSet *	Find (const char *path) const
virtual TDataSet *	FindByName (const char *name, const char *path="", Option_t *opt="") const
virtual TDataSet *	FindByPath (const char *path) const
	Aliase for TDataSet::Find(const Char_t *path) method.
virtual TDataSet *	FindByTitle (const char *title, const char *path="", Option_t *opt="") const
TObject *	FindObject (const char *name) const
TObject *	FindObject (const TObject *o) const
virtual TDataSet *	First () const
	Return the first object in the list. Returns 0 when list is empty.
TObjArray *	GetObjArray () const
virtual TSeqCollection *	GetCollection () const
TList *	GetList () const
virtual Int_t	GetListSize () const
TObject *	GetMother () const
virtual TObject *	GetObject () const
	The depricated method (left here for the sake of the backward compatibility)
virtual TDataSet *	GetParent () const
virtual Long_t	HasData () const
virtual TDataSet *	Instance () const
virtual TString	Path () const
	return the full path of this data set
virtual EDataSetPass	Pass (EDataSetPass(*callback)(TDataSet *), Int_t depth=0)
virtual EDataSetPass	Pass (EDataSetPass(*callback)(TDataSet *, void *), void *user, Int_t depth=0)
virtual void	PrintContents (Option_t *opt="") const
virtual Int_t	Purge (Option_t *opt="")
virtual void	Remove (TDataSet *set)
	Remiove the "set" from this TDataSet.
virtual TDataSet *	RemoveAt (Int_t idx)
virtual void	SetMother (TDataSet *parent=0)
virtual void	SetObject (TObject *obj)
	The depricated method (left here for the sake of the backward compatibility)
virtual void	SetParent (TDataSet *parent=0)
virtual void	SetWrite ()
virtual void	Shunt (TDataSet *newParent=0)
virtual void	Sort ()
	Sort recursively all members of the TDataSet with TList::Sort method.
virtual Bool_t	IsEmpty () const
	return kTRUE if the "internal" collection has no member
virtual Bool_t	IsFolder () const
virtual Bool_t	IsMarked () const
virtual Bool_t	IsThisDir (const char *dirname, int len=-1, int ignorecase=0) const
virtual TDataSet *	Last () const
	Return the last object in the list. Returns 0 when list is empty.
virtual void	ls (Option_t *option="") const
virtual void	ls (Int_t depth) const
void	Mark ()
void	UnMark ()
void	MarkAll ()
	Mark all members of this dataset.
void	UnMarkAll ()
	UnMark all members of this dataset.
void	InvertAllMarks ()
	Invert mark bit for all members of this dataset.
void	Mark (UInt_t flag, EBitOpt reset=kSet)
virtual TDataSet *	Next () const
virtual TDataSet *	Prev () const
virtual void	Update ()
virtual void	Update (TDataSet *set, UInt_t opt=0)
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const

Protected Member Functions
	ClassDef (StarGenEventReader, 1)
Protected Member Functions inherited from StarGenerator
	ClassDef (StarGenerator, 1)
Protected Member Functions inherited from StMaker
StMessMgr *	GetLogger () const
virtual TDataSet *	FindDataSet (const char *logInput, const StMaker *uppMk=0, const StMaker *dowMk=0) const
Protected Member Functions inherited from TDataSet
virtual void	SetMother (TObject *mother)
	TDataSet (const char *name, const char *title)
void	AddMain (TDataSet *set)
	add data set to main data set
TDataSet *	GetRealParent ()
	return real parent
void	MakeCollection ()
	Create the internal container at once if any.

Protected Attributes
Int_t	mEntry
Protected Attributes inherited from StarGenerator
const Double_t	mm
	If an event generator measures distances in mm, then multiply by mm.
const Double_t	cm
	If an event generator measures distances in cm, then multiply by cm.
Int_t	mNumberOfParticles
StarGenEvent *	mEvent
	Generated event.
TString	mBlue
	Name of the blue beam particle (+z)
TString	mYell
	Name of the yellow beam particle (-z)
TString	mFrame
	Frame of the collision, i.e. CMS, FIXT, 3MOM, 4MOM, 5MOM.
Double_t	mRootS
	CMS energy or incident beam momentum for fixed target collisions.
Double_t	mDirect
	Direction (+1 = W, -1 = E) of the beam in fixted target mode.
Double_t	mImpactMin
	Minimum impact parameter in a HI collision.
Double_t	mImpactMax
	Maximum impact parameter in a HI collision.
TLorentzVector	mBlueMomentum
	4-Momentum of the blue beam
TLorentzVector	mYellMomentum
	4-Momentum of the yellow beam
Double_t	mBlueMass
	Mass of the blue beam.
Double_t	mYellMass
	Mass of the yellow beam.
Double_t	mVertex [3]
	Position of the interaction vertex.
Double_t	mSpread [3]
	Width of the interaction vertex.
Int_t	mIOMode
	IO flag. 0=no IO, 1=write, 2=read.
TTree *	mInputTree
	Pointer to the tree for reading in events.
TTree *	mOutputTree
	Pointer to the tree for writing out events.
Bool_t	mIsPileup
	Flag which indicates whether this is a pileup simulation.
Double_t	mPileup
	Indicates the probability that this generator should be run in pileup mode.
StarParticleData *	mParticleDb
	Database for particle information (based on TDatabasePDG)
TString	mLibrary
	Concrete event generator library.
Protected Attributes inherited from StMaker
TDataSet *	m_DataSet
TDataSet *	m_ConstSet
TDataSet *	m_GarbSet
TDataSet *	m_Inputs
TDataSet *	m_Ouputs
	list of logInput:ActualInput
TDataSet *	m_Runco
	list of logOuput:ActualOuput
TList *	m_Histograms
	Run Control parameters.
Int_t	fTallyMaker [kStFatal+1]
	counters
Int_t	m_Mode
	counters
Int_t	m_Number
	Integer mode of maker.
Int_t	m_LastRun
	Serial event number.
Int_t	m_DebugLevel
	Last Run number.
Int_t	m_MakeReturn
	Debug level.
TStopwatch	m_Timer
	Make() return flag.
StMemStat *	fMemStatMake
	Timer object.
StMemStat *	fMemStatClear
	StMemStat for Make.
Int_t	fStatus
	StMemStat for Clear.
StMessMgr *	fLogger
	Maker status.
StTurnLogger *	fLoggerHold
Protected Attributes inherited from TDataSet
TDataSet *	fParent
TSeqCollection *	fList

Additional Inherited Members
Public Types inherited from StMaker
enum	EDebugLevel { kNormal, kDebug }
enum	{ kSTAFCV_BAD, kSTAFCV_OK, kSTAFCV_ERR =2, kSTAFCV_FATAL =3 }
enum	EMakerStatus {   kInitBeg = 1, kInitEnd = 2, kMakeBeg = 3, kCleaBeg = 4,   kFiniBeg = 5, kFiniEnd = 6, kActive = 7 }
Public Types inherited from TDataSet
enum	EDataSetPass {   kContinue, kPrune, kStop, kUp,   kStruct, kAll, kRefs, kMarked }
enum	ESetBits { kMark = BIT(22), kArray = BIT(20) }
enum	EBitOpt { kSet = kTRUE, kReset = kFALSE }
Static Public Member Functions inherited from StMaker
static StMaker *	New (const char *classname, const char *name="", void *title=0)
static StMaker *	GetTopChain ()
static StMaker *	GetChain ()
static StMaker *	GetFailedMaker ()
static StMaker *	GetMaker (const TDataSet *ds)
	Static functions.
static EDataSetPass	ClearDS (TDataSet *ds, void *user)
static const char *	RetCodeAsString (Int_t kode)
static Int_t	AliasDate (const char *alias)
static Int_t	AliasTime (const char *alias)
static const char *	AliasGeometry (const char *alias)
static const DbAlias_t *	GetDbAliases ()
static void	SetTestMaker (StTestMaker *mk)
static Int_t	Cleanup (TDataSet *&ds)
static void	lsMakers (const StMaker *top)
Static Public Member Functions inherited from TDataSet
static TDataSet *	GetMainSet ()
	return pointer to the main dataset
static TDataSet *	instance ()
Public Attributes inherited from StMaker
enum StMaker:: { ... }	EModule_return_Status
Static Protected Member Functions inherited from TDataSet
static EDataSetPass	SortIt (TDataSet *ds)
static EDataSetPass	SortIt (TDataSet *ds, void *user)
Static Protected Attributes inherited from StMaker
static StMaker *	fgTopChain = 0
	list of Histograms
static StMaker *	fgStChain = 0
	pointer to top StChain
static StMaker *	fgFailedMaker = 0
	current pointer to StChain
static StTestMaker *	fgTestMaker = 0
	current pointer to failed maker
static Int_t	fgTallyMaker [kStFatal+1] = {0,0,0,0,0}
Static Protected Attributes inherited from TDataSet
static TDataSet *	fgMainSet = &mainSet

Detailed Description

Definition at line 7 of file StarGenEventReader.h.

Member Function Documentation

Int_t StarGenEventReader::Generate ( )

virtual

Developers must provide a generate method. In this method, the event generation machinery should be called. It is expected that the event record is filled in the Generate method, so that particles and event characteristics are available to subsequent generators and the primary generator maker. The primary maker is responsible for pushing particles out to the concrete simulation package.

Implements StarGenerator.

Definition at line 9 of file StarGenEventReader.cxx.

References kStOK, StarGenerator::mEvent, StarGenerator::mInputTree, and StarGenEvent::Print().

Int_t StarGenEventReader::Init ( )

virtual

Developer must provide initialization routine. This method should call any functions, subroutines and/or methods on the concrete event generator necessary for its initialization.

Implements StarGenerator.

Definition at line 4 of file StarGenEventReader.cxx.

References kStOK.

---

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

• StarGenerator/StarGenEventReader/StarGenEventReader.h
• StarGenerator/StarGenEventReader/StarGenEventReader.cxx