gparticle_reader.h File Reference

#include "gparticle.h"
#include "gbase.h"
#include "gdl.h"
#include "goptions.h"
#include <memory>
#include <string>
#include <utility>
#include <vector>

Include dependency graph for gparticle_reader.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GParticleRecord
	Immutable generated-particle metadata used for output banks. More...
struct	GParticleSourceDefinition
	One configured -gparticlefile source. More...
class	GParticleReader
	Abstract base class for gparticle file readers. More...

Namespaces
namespace	gparticle

Typedefs
using	GParticleEvent = std::vector<GparticlePtr>
	Event-local list of Geant4-propagated generator particles.
using	GParticleEvents = std::vector<GParticleEvent>
	Sequence of file-backed generated-particle events.
using	GParticleRecordEvent = std::vector<GParticleRecord>
	Event-local list of generated-particle records for output.
using	GParticleRecordEvents = std::vector<GParticleRecordEvent>
	Sequence of generated-particle record events indexed by event number.

Functions
std::vector< GParticleSourceDefinition >	gparticle::getGParticleSourceDefinitions (const std::shared_ptr< GOptions > &gopts)
	Parses all configured -gparticlefile entries.
std::vector< GparticlePtr >	gparticle::getGParticlesFromSources (const std::shared_ptr< GOptions > &gopts, std::shared_ptr< GLogger > &logger)
	Loads propagated particles from all configured file sources.
GParticleEvents	gparticle::getGParticleEventsFromSources (const std::shared_ptr< GOptions > &gopts, std::shared_ptr< GLogger > &logger, bool propagated_only=true)
	Loads event-indexed propagated particles from all configured file sources.
GParticleRecordEvents	gparticle::getGParticleRecordEventsFromSources (const std::shared_ptr< GOptions > &gopts, std::shared_ptr< GLogger > &logger)
	Loads event-indexed generated-particle records from all configured file sources.
const std::vector< std::string > &	gparticle::supported_static_reader_formats ()
	Returns built-in file-reader format tokens.

Typedef Documentation

GParticleEvent

using GParticleEvent = std::vector<GparticlePtr>

Each entry is a Gparticle that can be shot into a G4Event. File readers usually populate this list with only the particles that should be propagated by Geant4, such as Lund rows with type == 1.

Definition at line 24 of file gparticle_reader.h.

GParticleEvents

using GParticleEvents = std::vector<GParticleEvent>

The outer vector is indexed by event number; each inner vector contains the particles for that input event that can be represented as Gparticle objects and propagated to Geant4.

Definition at line 33 of file gparticle_reader.h.

GParticleRecordEvent

using GParticleRecordEvent = std::vector<GParticleRecord>

Definition at line 84 of file gparticle_reader.h.

GParticleRecordEvents

using GParticleRecordEvents = std::vector<GParticleRecordEvent>

Definition at line 89 of file gparticle_reader.h.