cepgen is hosted by Hepforge, IPPP Durham
CepGen 1.2.3
A generic central exclusive processes event generator
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
ParticleProperties Struct Referencefinal

A collection of physics constants associated to a single particle. More...

#include <CepGen/Physics/ParticleProperties.h>

+ Inheritance diagram for ParticleProperties:
+ Collaboration diagram for ParticleProperties:

Public Member Functions

 ParticleProperties (const ParametersList &)
 
 ParticleProperties (pdgid_t pdgid=0ull, const std::string &name="", const std::string &descr="", int colours=-1, double mass=-1., double width=-1., const std::vector< int > &charges={}, bool fermion=false)
 
short integerCharge () const
 Integer charge, in \(e\)/3.
 
bool operator== (const SteeredObject &oth) const
 Equality operator.
 
bool operator!= (const SteeredObject &oth) const
 Inequality operator.
 
const ParametersList & parameters () const override
 Module user-defined parameters.
 
virtual void setParameters (const ParametersList &params) override
 Set module parameters.
 
void setDescribedParameters (const ParametersList &params_orig)
 Set (documented) module parameters.
 

Static Public Member Functions

static ParametersDescription description ()
 

Public Attributes

pdgid_t pdgid {0ull}
 PDG identifier.
 
std::string name {}
 Particle name.
 
std::string descr {}
 Human-readable name.
 
int colours {0}
 Colour factor.
 
double mass {0.}
 Mass, in GeV/c \(^2\).
 
double width {0.}
 Decay width, in GeV/c \(^2\).
 
std::vector< int > charges {}
 Electric charges, in \(e\)/3.
 
bool fermion {false}
 Is the particle a fermion?
 

Protected Member Functions

template<typename T >
T steer (const std::string &key) const
 Retrieve a parameters as previously steered.
 
template<typename T , typename U >
U steerAs (const std::string &key) const
 Retrieve a recasted parameters as previously steered.
 
std::string steerName () const
 Retrieve module name from parameters.
 
std::string steerPath (const std::string &key) const
 Retrieve a path from common search paths.
 

Protected Attributes

ParametersList params_
 Module parameters.
 

Friends

std::ostream & operator<< (std::ostream &, const ParticleProperties &)
 

Detailed Description

Definition at line 31 of file ParticleProperties.h.

Constructor & Destructor Documentation

◆ ParticleProperties() [1/2]

ParticleProperties ( const ParametersList &  params)
explicit

Definition at line 26 of file ParticleProperties.cpp.

◆ ParticleProperties() [2/2]

ParticleProperties ( pdgid_t  pdgid = 0ull,
const std::string &  name = "",
const std::string &  descr = "",
int  colours = -1,
double  mass = -1.,
double  width = -1.,
const std::vector< int > &  charges = {},
bool  fermion = false 
)
explicit

Definition at line 39 of file ParticleProperties.cpp.

Member Function Documentation

◆ description()

ParametersDescription description ( )
static

Definition at line 66 of file ParticleProperties.cpp.

◆ integerCharge()

short integerCharge ( ) const

Definition at line 57 of file ParticleProperties.cpp.

◆ operator!=()

bool operator!= ( const SteeredObject< ParticleProperties > &  oth) const
inherited

Definition at line 51 of file SteeredObject.h.

◆ operator==()

bool operator== ( const SteeredObject< ParticleProperties > &  oth) const
inherited

Definition at line 49 of file SteeredObject.h.

◆ parameters()

const ParametersList & parameters ( ) const
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

◆ setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig)
inherited

Definition at line 73 of file SteeredObject.h.

◆ setParameters()

virtual void setParameters ( const ParametersList &  params)
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 of file SteeredObject.h.

◆ steer()

template<typename T >
T steer ( const std::string &  key) const
protectedinherited

Definition at line 39 of file Steerable.h.

◆ steerAs()

template<typename T , typename U >
U steerAs ( const std::string &  key) const
protectedinherited

Definition at line 44 of file Steerable.h.

◆ steerName()

std::string steerName ( ) const
protectedinherited

Definition at line 48 of file Steerable.h.

◆ steerPath()

std::string steerPath ( const std::string &  key) const
protectedinherited

Definition at line 30 of file Steerable.cpp.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const ParticleProperties &  prop 
)
friend

Definition at line 79 of file ParticleProperties.cpp.

Member Data Documentation

◆ charges

std::vector<int> charges {}

Definition at line 54 of file ParticleProperties.h.

◆ colours

int colours {0}

Definition at line 51 of file ParticleProperties.h.

◆ descr

std::string descr {}

Definition at line 50 of file ParticleProperties.h.

◆ fermion

bool fermion {false}

Definition at line 55 of file ParticleProperties.h.

◆ mass

double mass {0.}

Definition at line 52 of file ParticleProperties.h.

◆ name

std::string name {}

Definition at line 49 of file ParticleProperties.h.

◆ params_

ParametersList params_
mutableprotectedinherited

Definition at line 50 of file Steerable.h.

◆ pdgid

pdgid_t pdgid {0ull}

Definition at line 48 of file ParticleProperties.h.

◆ width

double width {0.}

Definition at line 53 of file ParticleProperties.h.