BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Public Member Functions | Data Fields | Private Member Functions
GMAD::Scorer Class Reference

Scorer class for parser. More...

#include <scorer.h>

Inheritance diagram for GMAD::Scorer:
Inheritance graph
Collaboration diagram for GMAD::Scorer:
Collaboration graph

Public Member Functions

 Scorer ()
 Constructor. More...
 
void clear ()
 Reset. More...
 
void print () const
 Print some properties. More...
 
template<typename T >
void set_value (std::string property, T value)
 Set methods by property name and value. More...
 
- Public Member Functions inherited from GMAD::Published< Scorer >
bool NameExists (const std::string &name) const
 
Published< Scorer >::template AttributeMap< T > & attribute_map () const
 

Data Fields

std::string name
 Name. More...
 
std::string type
 Type of the scorer, ie forumula. More...
 
std::string particleName
 Particle name as a string. More...
 
int particlePDGID
 PDG ID code for particle. More...
 
double minimumKineticEnergy
 
double maximumKineticEnergy
 
double minimumTime
 
double maximumTime
 
std::string conversionFactorFile
 
std::string conversionFactorPath
 
std::string materialToInclude
 
std::string materialToExclude
 
bool scoreWorldVolumeOnly
 
bool scorePrimariesOnly
 

Private Member Functions

void PublishMembers ()
 publish members More...
 

Additional Inherited Members

- Protected Types inherited from GMAD::Published< Scorer >
using AttributeMap = typename std::unordered_map< std::string, T C::* >
 Define AttributeMap of string and class member pointer. More...
 
- Protected Member Functions inherited from GMAD::Published< Scorer >
void publish (const std::string &name, T C::*mp)
 Make pointer to member from class C and type T with accessible with a name. More...
 
void set (Scorer *instance, const Scorer *instance2, const std::string &name)
 Set member with name of class instance to value of second instance. More...
 
AttributeMap< T > & attribute_map () const
 Access method to static map for type T and class C.
 
get (const Scorer *instance, const std::string &name) const
 Get method for class C. More...
 
void set (Scorer *instance, const std::string &name, double value)
 
void set (Scorer *instance, const std::string &name, GMAD::Array *const &value)
 
void set (Scorer *instance, const std::string &name, const T &value)
 

Detailed Description

Scorer class for parser.

Author
Laurie Nevay

Definition at line 36 of file scorer.h.

Constructor & Destructor Documentation

◆ Scorer()

Scorer::Scorer ( )

Constructor.

Definition at line 23 of file scorer.cc.

References clear(), and PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void Scorer::clear ( )

Reset.

Definition at line 29 of file scorer.cc.

References name, particleName, particlePDGID, and type.

Referenced by Scorer().

Here is the caller graph for this function:

◆ print()

void Scorer::print ( ) const

Print some properties.

Definition at line 64 of file scorer.cc.

References name, particleName, particlePDGID, and type.

◆ PublishMembers()

void Scorer::PublishMembers ( )
private

publish members

Definition at line 46 of file scorer.cc.

References name, particleName, particlePDGID, GMAD::Published< Scorer >::publish(), and type.

Referenced by Scorer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_value()

template<typename T >
void GMAD::Scorer::set_value ( std::string  property,
value 
)

Set methods by property name and value.

Definition at line 70 of file scorer.h.

References GMAD::Published< Scorer >::set().

Here is the call graph for this function:

Field Documentation

◆ conversionFactorFile

std::string GMAD::Scorer::conversionFactorFile

Definition at line 47 of file scorer.h.

◆ conversionFactorPath

std::string GMAD::Scorer::conversionFactorPath

Definition at line 48 of file scorer.h.

◆ materialToExclude

std::string GMAD::Scorer::materialToExclude

Definition at line 50 of file scorer.h.

◆ materialToInclude

std::string GMAD::Scorer::materialToInclude

Definition at line 49 of file scorer.h.

◆ maximumKineticEnergy

double GMAD::Scorer::maximumKineticEnergy

Definition at line 44 of file scorer.h.

◆ maximumTime

double GMAD::Scorer::maximumTime

Definition at line 46 of file scorer.h.

◆ minimumKineticEnergy

double GMAD::Scorer::minimumKineticEnergy

Definition at line 43 of file scorer.h.

◆ minimumTime

double GMAD::Scorer::minimumTime

Definition at line 45 of file scorer.h.

◆ name

std::string GMAD::Scorer::name

Name.

Definition at line 39 of file scorer.h.

Referenced by BDSScorerInfo::BDSScorerInfo(), clear(), print(), and PublishMembers().

◆ particleName

std::string GMAD::Scorer::particleName

Particle name as a string.

Definition at line 41 of file scorer.h.

Referenced by BDSScorerInfo::BDSScorerInfo(), clear(), print(), and PublishMembers().

◆ particlePDGID

int GMAD::Scorer::particlePDGID

PDG ID code for particle.

Definition at line 42 of file scorer.h.

Referenced by BDSScorerInfo::BDSScorerInfo(), clear(), print(), and PublishMembers().

◆ scorePrimariesOnly

bool GMAD::Scorer::scorePrimariesOnly

Definition at line 52 of file scorer.h.

◆ scoreWorldVolumeOnly

bool GMAD::Scorer::scoreWorldVolumeOnly

Definition at line 51 of file scorer.h.

◆ type

std::string GMAD::Scorer::type

Type of the scorer, ie forumula.

Definition at line 40 of file scorer.h.

Referenced by BDSScorerInfo::BDSScorerInfo(), clear(), print(), and PublishMembers().


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