#include <EDepSimVKinematicsGenerator.hh>

Inheritance diagram for EDepSim::VKinematicsGenerator:

Public Types
enum	GeneratorStatus { kFail = 0, kSuccess, kLastVertex, kEndEvent }
	A status value that can be returned by GeneratePrimaryVertex. More...

Public Member Functions
	VKinematicsGenerator (const G4String &name)

virtual	~VKinematicsGenerator ()

virtual GeneratorStatus	GeneratePrimaryVertex (G4Event *evt, const G4LorentzVector &position)=0

G4String	GetName () const
	Return the name of the generator. More...

Private Attributes
G4String	fName
	The name of the generator. More...

Detailed Description

Definition at line 25 of file EDepSimVKinematicsGenerator.hh.

Member Enumeration Documentation

enum EDepSim::VKinematicsGenerator::GeneratorStatus

A status value that can be returned by GeneratePrimaryVertex.

Enumerator
kFail	The generation failed and should be tried again.
kSuccess	A vertex was successfully generated.
kLastVertex	The new vertex should be generated, but it is the last one for the event. This only has an effect if the EDepSim::PrimaryGenerator object is building a multiple vertex event.
kEndEvent	A new vertex should not be generated and EDepSim::PrimaryGenerator should return. It is the users responsibility to make sure that at least one primary vertex will have been generated.

Definition at line 31 of file EDepSimVKinematicsGenerator.hh.

                  {
         /// The generation failed and should be tried again.
         kFail = 0,
         /// A vertex was successfully generated.
         kSuccess,
         /// The new vertex should be generated, but it is the last one for the
         /// event.  This only has an effect if the EDepSim::PrimaryGenerator
         /// object is building a multiple vertex event.
         kLastVertex,
         /// A new vertex should not be generated and EDepSim::PrimaryGenerator
         /// should return.  It is the users responsibility to make sure that
         /// at least one primary vertex will have been generated.
         kEndEvent,
     } GeneratorStatus;

Constructor & Destructor Documentation

EDepSim::VKinematicsGenerator::VKinematicsGenerator ( const G4String & name )

inline

Definition at line 27 of file EDepSimVKinematicsGenerator.hh.

27 : fName(name) {}

name

static QCString name

Definition: declinfo.cpp:673

EDepSim::VKinematicsGenerator::fName

G4String fName

The name of the generator.

Definition: EDepSimVKinematicsGenerator.hh:60

virtual EDepSim::VKinematicsGenerator::~VKinematicsGenerator ( )

inlinevirtual

Definition at line 28 of file EDepSimVKinematicsGenerator.hh.

28 {}

Member Function Documentation

virtual GeneratorStatus EDepSim::VKinematicsGenerator::GeneratePrimaryVertex	(	G4Event *	evt,
		const G4LorentzVector &	position
	)

pure virtual

Add a G4PrimaryVertex object to the event. This should return EDepSim::VKinematicsGenerator::kFail if a vertex could not be generated for some reason (e.g. an event was discarded due to event weighting probabilities, or occurred on an illegal target). The vertex will be constructed as normal for G4, and added using the G4Event::AddPrimaryVertex(G4PrimaryVertex*) method.

Implemented in EDepSim::RooTrackerKinematicsGenerator, EDepSim::GPSKinematicsGenerator, and EDepSim::NuMIRockKinematicsGenerator.

G4String EDepSim::VKinematicsGenerator::GetName ( void ) const

inline

Return the name of the generator.

Definition at line 56 of file EDepSimVKinematicsGenerator.hh.

56 {return fName;}

EDepSim::VKinematicsGenerator::fName

G4String fName

The name of the generator.

Definition: EDepSimVKinematicsGenerator.hh:60