DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Types | Public Member Functions | Public Attributes | Private Member Functions | List of all members
dd4hep::sim::Geant4PrimaryInteraction Class Reference

Class modelling a single interaction with multiple primary vertices and particles. More...

#include <Geant4Primary.h>

Public Types

typedef Geant4Particle Particle
 
typedef Geant4Vertex Vertex
 
typedef std::map< int, Particle * > ParticleMap
 
typedef std::map< int, std::vector< Vertex * > > VertexMap
 
typedef dd4hep_ptr< PrimaryExtensionExtensionHandle
 

Public Member Functions

 Geant4PrimaryInteraction ()=default
 Default constructor. More...
 
virtual ~Geant4PrimaryInteraction ()
 Default destructor. More...
 
int nextPID ()
 Access a new particle identifier within the interaction. More...
 
void setNextPID (int value)
 Set the next PID value. More...
 
bool applyMask ()
 Apply mask to all contained vertices (max. 1) and particles. More...
 

Public Attributes

VertexMap vertices
 The map of primary vertices for the particles. More...
 
ParticleMap particles
 The map of particles participating in this primary interaction. More...
 
ExtensionHandle extension
 User data extension if required. More...
 
int mask = 0
 User mask to flag the interaction. Also unique identifier. More...
 
int locked = 0
 Flag that the event is locked for G4 native generators. More...
 
int next_particle_identifier = -1
 Next PID indentifier. More...
 

Private Member Functions

 Geant4PrimaryInteraction (const Geant4PrimaryInteraction &c)=delete
 Copy constructor. More...
 
Geant4PrimaryInteractionoperator= (const Geant4PrimaryInteraction &c)=delete
 Assignment operator. More...
 

Detailed Description

Class modelling a single interaction with multiple primary vertices and particles.

Definition at line 95 of file Geant4Primary.h.

Member Typedef Documentation

◆ ExtensionHandle

Definition at line 107 of file Geant4Primary.h.

◆ Particle

Definition at line 103 of file Geant4Primary.h.

◆ ParticleMap

Definition at line 105 of file Geant4Primary.h.

◆ Vertex

Definition at line 104 of file Geant4Primary.h.

◆ VertexMap

typedef std::map<int,std::vector<Vertex*> > dd4hep::sim::Geant4PrimaryInteraction::VertexMap

Definition at line 106 of file Geant4Primary.h.

Constructor & Destructor Documentation

◆ Geant4PrimaryInteraction() [1/2]

dd4hep::sim::Geant4PrimaryInteraction::Geant4PrimaryInteraction ( const Geant4PrimaryInteraction c)
privatedelete

Copy constructor.

◆ Geant4PrimaryInteraction() [2/2]

dd4hep::sim::Geant4PrimaryInteraction::Geant4PrimaryInteraction ( )
default

Default constructor.

◆ ~Geant4PrimaryInteraction()

Geant4PrimaryInteraction::~Geant4PrimaryInteraction ( )
virtual

Default destructor.

Definition at line 56 of file Geant4Primary.cpp.

Member Function Documentation

◆ applyMask()

bool Geant4PrimaryInteraction::applyMask ( )

Apply mask to all contained vertices (max. 1) and particles.

Apply mask to all contained vertices and particles.

Definition at line 75 of file Geant4Primary.cpp.

◆ nextPID()

int Geant4PrimaryInteraction::nextPID ( )

Access a new particle identifier within the interaction.

Definition at line 65 of file Geant4Primary.cpp.

◆ operator=()

Geant4PrimaryInteraction& dd4hep::sim::Geant4PrimaryInteraction::operator= ( const Geant4PrimaryInteraction c)
privatedelete

Assignment operator.

◆ setNextPID()

void Geant4PrimaryInteraction::setNextPID ( int  value)

Set the next PID value.

Access a new particle identifier within the interaction.

Definition at line 70 of file Geant4Primary.cpp.

Member Data Documentation

◆ extension

ExtensionHandle dd4hep::sim::Geant4PrimaryInteraction::extension

User data extension if required.

Definition at line 114 of file Geant4Primary.h.

◆ locked

int dd4hep::sim::Geant4PrimaryInteraction::locked = 0

Flag that the event is locked for G4 native generators.

Definition at line 118 of file Geant4Primary.h.

◆ mask

int dd4hep::sim::Geant4PrimaryInteraction::mask = 0

User mask to flag the interaction. Also unique identifier.

Definition at line 116 of file Geant4Primary.h.

◆ next_particle_identifier

int dd4hep::sim::Geant4PrimaryInteraction::next_particle_identifier = -1

Next PID indentifier.

Definition at line 120 of file Geant4Primary.h.

◆ particles

ParticleMap dd4hep::sim::Geant4PrimaryInteraction::particles

The map of particles participating in this primary interaction.

Definition at line 112 of file Geant4Primary.h.

◆ vertices

VertexMap dd4hep::sim::Geant4PrimaryInteraction::vertices

The map of primary vertices for the particles.

Definition at line 110 of file Geant4Primary.h.


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