BDSScorerInfo Class Reference

Recipe class for scorer. Checks values. More...

#include <BDSScorerInfo.hh>

Collaboration diagram for BDSScorerInfo:

Public Member Functions
	BDSScorerInfo ()=delete
	No default constructor as unused.
	BDSScorerInfo (const GMAD::Scorer &scorer, G4bool upgradeTo3D=false)
void	CheckParticle (G4ParticleDefinition *particleIn, const G4String &nameIn)
	Utility function to check valid pointer and throw exception if not.

Data Fields
BDSScorerType	scorerType
	Scorer type.
G4String	name
	Scorer name.
G4ParticleDefinition *	particle
	Particle filter.
G4double	minimumKineticEnergy
G4double	maximumKineticEnergy
G4double	minimumTime
G4double	maximumTime
G4String	filename
	Name of the conversion factor file.
G4String	pathname
	Path of the conversion factor file (for ambient dose)
std::vector< G4Material * >	materialsToInclude
std::vector< G4Material * >	materialsToExclude
	Which materials to include for scoring.
G4bool	worldVolumeOnly
	Which materials to exclude for scoring.
G4bool	primariesOnly

Detailed Description

Recipe class for scorer. Checks values.

Convert a parser scorer instance to one using Geant4 types and units. Check values and find particle definition.

Author

Robin Tesse

Definition at line 45 of file BDSScorerInfo.hh.

Constructor & Destructor Documentation

BDSScorerInfo()

BDSScorerInfo::BDSScorerInfo ( const GMAD::Scorer &  scorer, G4bool  upgradeTo3D = false  )

explicit

Constructor. If upgradeTo3D is true, some scorer types will be upgraded to 3d as required for use in a mesh.

Definition at line 39 of file BDSScorerInfo.cc.

References CheckParticle(), BDS::DetermineScorerType(), filename, BDSMaterials::GetMaterial(), BDSMaterials::Instance(), materialsToExclude, name, GMAD::Scorer::name, particle, GMAD::Scorer::particleName, GMAD::Scorer::particlePDGID, pathname, scorerType, BDS::SplitOnWhiteSpace(), BDS::StrContains(), GMAD::Scorer::type, BDSException::what(), and worldVolumeOnly.

Here is the call graph for this function:

Member Function Documentation

CheckParticle()

void BDSScorerInfo::CheckParticle	(	G4ParticleDefinition *	particleIn,
		const G4String &	nameIn
	)

Utility function to check valid pointer and throw exception if not.

Definition at line 112 of file BDSScorerInfo.cc.

Referenced by BDSScorerInfo().

Here is the caller graph for this function:

Field Documentation

filename

G4String BDSScorerInfo::filename

Name of the conversion factor file.

Definition at line 67 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), and BDSScorerFactory::GetAppropriateScorer().

materialsToExclude

std::vector<G4Material*> BDSScorerInfo::materialsToExclude

Which materials to include for scoring.

Definition at line 70 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), and BDSScorerFactory::CreateFilter().

materialsToInclude

std::vector<G4Material*> BDSScorerInfo::materialsToInclude

Definition at line 69 of file BDSScorerInfo.hh.

maximumKineticEnergy

G4double BDSScorerInfo::maximumKineticEnergy

Definition at line 64 of file BDSScorerInfo.hh.

maximumTime

G4double BDSScorerInfo::maximumTime

Definition at line 66 of file BDSScorerInfo.hh.

minimumKineticEnergy

G4double BDSScorerInfo::minimumKineticEnergy

Definition at line 63 of file BDSScorerInfo.hh.

minimumTime

G4double BDSScorerInfo::minimumTime

Definition at line 65 of file BDSScorerInfo.hh.

name

G4String BDSScorerInfo::name

Scorer name.

Definition at line 61 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), BDS::BuildBLMs(), BDSDetectorConstruction::ConstructScoringMeshes(), BDSScorerFactory::CreateScorer(), and BDSScorerFactory::GetAppropriateScorer().

particle

G4ParticleDefinition* BDSScorerInfo::particle

Particle filter.

Definition at line 62 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), and BDSScorerFactory::CreateFilter().

pathname

G4String BDSScorerInfo::pathname

Path of the conversion factor file (for ambient dose)

Definition at line 68 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), and BDSScorerFactory::GetAppropriateScorer().

primariesOnly

G4bool BDSScorerInfo::primariesOnly

Definition at line 72 of file BDSScorerInfo.hh.

scorerType

BDSScorerType BDSScorerInfo::scorerType

Scorer type.

Definition at line 60 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), and BDSScorerFactory::GetAppropriateScorer().

worldVolumeOnly

G4bool BDSScorerInfo::worldVolumeOnly

Which materials to exclude for scoring.

Whether to score from the world volume only

Definition at line 71 of file BDSScorerInfo.hh.

Referenced by BDSScorerInfo(), and BDSScorerFactory::CreateFilter().

---

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

• /__w/bdsim/bdsim/include/BDSScorerInfo.hh
• /__w/bdsim/bdsim/src/BDSScorerInfo.cc