FairRoot
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FairBaseMCGenerator Class Reference

#include <FairBaseMCGenerator.h>

Inheritance diagram for FairBaseMCGenerator:
FairGenerator FairBoxGenerator FairIonGenerator FairParticleGenerator FairYPtGenerator

Public Types

enum  eVertexSmear { kBox, kGauss, kExp }
 

Public Member Functions

 FairBaseMCGenerator ()
 
void SetPDGType (Int_t pdg)
 
void SetVertex (Double_t vx, Double_t vy, Double_t vz, Double_t evx=0, Double_t evy=0, Double_t evz=0, eVertexSmear sm=kBox)
 
void SetMultiplicity (Int_t mult)
 
virtual Bool_t Init ()
 
virtual ~FairBaseMCGenerator ()
 
- Public Member Functions inherited from FairGenerator
 FairGenerator ()
 
 FairGenerator (const char *name, const char *title="FAIR Generator")
 
virtual ~FairGenerator ()
 
virtual Bool_t ReadEvent (FairPrimaryGenerator *primGen)=0
 
virtual FairGeneratorCloneGenerator () const
 

Protected Member Functions

 FairBaseMCGenerator (const FairBaseMCGenerator &other)=default
 
FairBaseMCGeneratoroperator= (const FairBaseMCGenerator &rhs)=default
 
Int_t GetPDGType () const
 
Int_t GetMultiplicity () const
 
Double_t GetPDGMass () const
 
virtual void GenerateEventParameters ()
 
Double_t GetVxAv () const
 
Double_t GetVyAv () const
 
Double_t GetVzAv () const
 
Double_t GetVxRms () const
 
Double_t GetVyRms () const
 
Double_t GetVzRms () const
 
- Protected Member Functions inherited from FairGenerator
 FairGenerator (const FairGenerator &)
 
FairGeneratoroperator= (const FairGenerator &)
 
 ClassDef (FairGenerator, 1)
 

Protected Attributes

Double_t fX
 
Double_t fY
 
Double_t fZ
 

Detailed Description

abstract class for generators that use "macro input" to generate partcles

Definition at line 17 of file FairBaseMCGenerator.h.

Member Enumeration Documentation

Enumerator
kBox 
kGauss 
kExp 

Definition at line 20 of file FairBaseMCGenerator.h.

Constructor & Destructor Documentation

FairBaseMCGenerator::FairBaseMCGenerator ( )

Definition at line 17 of file FairBaseMCGenerator.cxx.

FairBaseMCGenerator::~FairBaseMCGenerator ( )
virtual

Definition at line 51 of file FairBaseMCGenerator.cxx.

FairBaseMCGenerator::FairBaseMCGenerator ( const FairBaseMCGenerator other)
protecteddefault

Member Function Documentation

void FairBaseMCGenerator::GenerateEventParameters ( )
protectedvirtual

generate event parameters like current event

Definition at line 71 of file FairBaseMCGenerator.cxx.

Int_t FairBaseMCGenerator::GetMultiplicity ( ) const
inlineprotected

Definition at line 57 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetPDGMass ( ) const
inlineprotected

Definition at line 58 of file FairBaseMCGenerator.h.

Int_t FairBaseMCGenerator::GetPDGType ( ) const
inlineprotected

Definition at line 56 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetVxAv ( ) const
inlineprotected

Definition at line 63 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetVxRms ( ) const
inlineprotected

Definition at line 66 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetVyAv ( ) const
inlineprotected

Definition at line 64 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetVyRms ( ) const
inlineprotected

Definition at line 67 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetVzAv ( ) const
inlineprotected

Definition at line 65 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::GetVzRms ( ) const
inlineprotected

Definition at line 68 of file FairBaseMCGenerator.h.

Bool_t FairBaseMCGenerator::Init ( )
virtual

Initialize the generator if needed

Reimplemented from FairGenerator.

Reimplemented in FairBoxGenerator, and FairYPtGenerator.

Definition at line 56 of file FairBaseMCGenerator.cxx.

FairBaseMCGenerator& FairBaseMCGenerator::operator= ( const FairBaseMCGenerator rhs)
protecteddefault
void FairBaseMCGenerator::SetMultiplicity ( Int_t  mult)
inline

set number of particles per event

Parameters
mult

Definition at line 49 of file FairBaseMCGenerator.h.

void FairBaseMCGenerator::SetPDGType ( Int_t  pdg)

set PDG code of generated particles

Parameters
pdg

Definition at line 69 of file FairBaseMCGenerator.cxx.

void FairBaseMCGenerator::SetVertex ( Double_t  vx,
Double_t  vy,
Double_t  vz,
Double_t  evx = 0,
Double_t  evy = 0,
Double_t  evz = 0,
eVertexSmear  sm = kBox 
)

set vertex position and algorithm of vertex generation

Parameters
vx,vy,vzVertex coordinates [cm]
evx,evy,evzVertex dispersion [cm]
smdistribution of vertex, gaussian or box

Definition at line 34 of file FairBaseMCGenerator.cxx.

Member Data Documentation

Double_t FairBaseMCGenerator::fX
protected

Definition at line 69 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::fY
protected

Definition at line 69 of file FairBaseMCGenerator.h.

Double_t FairBaseMCGenerator::fZ
protected

Definition at line 69 of file FairBaseMCGenerator.h.


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