#include </builds/gaudi/Gaudi/GaudiPartProp/include/Gaudi/Tr/TrackDefaultParticles.h>

Collaboration diagram for Gaudi::Tr::PID:

Public Member Functions
constexpr	PID (const int id)
constexpr	PID (validated_pid_t pid)
	PID ()=delete
constexpr double	mass () const
constexpr bool	isElectron () const
constexpr bool	isMuon () const
constexpr bool	isPion () const
constexpr bool	isKaon () const
constexpr bool	isProton () const

Static Public Member Functions
static constexpr PID	Electron ()
static constexpr PID	Muon ()
static constexpr PID	Pion ()
static constexpr PID	Kaon ()
static constexpr PID	Proton ()

Private Types
enum class	validated_pid_t { Electron = 0 , Muon , Pion , Kaon , Proton }

Static Private Member Functions
static constexpr validated_pid_t	validate (int id)

Private Attributes
validated_pid_t	m_value

Static Private Attributes
static constexpr std::array< double, 5 >	s_mass = { 0.51099891, 105.65837, 139.57018, 493.677, 938.27203 }

Friends
const char *	toString (PID pid)
std::ostream &	toStream (const PID &pid, std::ostream &os)
std::ostream &	operator<< (std::ostream &os, const PID &pid)
StatusCode	parse (PID &pid, std::string_view in)

Detailed Description

Definition at line 21 of file TrackDefaultParticles.h.

Member Enumeration Documentation

◆ validated_pid_t

enum class Gaudi::Tr::PID::validated_pid_t

strongprivate

Enumerator
Electron
Muon
Pion
Kaon
Proton

Definition at line 22 of file TrackDefaultParticles.h.

22{ Electron = 0, Muon, Pion, Kaon, Proton };

Constructor & Destructor Documentation

◆ PID() [1/3]

Gaudi::Tr::PID::PID ( const int id )

inlineexplicitconstexpr

Definition at line 45 of file TrackDefaultParticles.h.

45: m_value( validate( id ) ) {}

Gaudi::Tr::PID::validate

static constexpr validated_pid_t validate(int id)

Definition TrackDefaultParticles.h:27

Gaudi::Tr::PID::m_value

validated_pid_t m_value

Definition TrackDefaultParticles.h:25

◆ PID() [2/3]

Gaudi::Tr::PID::PID ( validated_pid_t pid )

inlineexplicitconstexpr

Definition at line 47 of file TrackDefaultParticles.h.

47: m_value( pid ) {}

◆ PID() [3/3]

Gaudi::Tr::PID::PID ( )

delete

Member Function Documentation

◆ Electron()

constexpr PID Gaudi::Tr::PID::Electron ( )

inlinestaticconstexpr

Definition at line 52 of file TrackDefaultParticles.h.

52{ return PID{ validated_pid_t::Electron }; }

Gaudi::Tr::PID::validated_pid_t::Electron

@ Electron

Definition TrackDefaultParticles.h:22

Gaudi::Tr::PID::PID

constexpr PID(const int id)

Definition TrackDefaultParticles.h:45

◆ isElectron()

bool Gaudi::Tr::PID::isElectron ( ) const

inlineconstexpr

Definition at line 97 of file TrackDefaultParticles.h.

97{ return validated_pid_t::Electron == m_value; }

◆ isKaon()

bool Gaudi::Tr::PID::isKaon ( ) const

inlineconstexpr

Definition at line 103 of file TrackDefaultParticles.h.

103{ return validated_pid_t::Kaon == m_value; }

Gaudi::Tr::PID::validated_pid_t::Kaon

@ Kaon

Definition TrackDefaultParticles.h:22

◆ isMuon()

bool Gaudi::Tr::PID::isMuon ( ) const

inlineconstexpr

Definition at line 99 of file TrackDefaultParticles.h.

99{ return validated_pid_t::Muon == m_value; }

Gaudi::Tr::PID::validated_pid_t::Muon

@ Muon

Definition TrackDefaultParticles.h:22

◆ isPion()

bool Gaudi::Tr::PID::isPion ( ) const

inlineconstexpr

Definition at line 101 of file TrackDefaultParticles.h.

101{ return validated_pid_t::Pion == m_value; }

Gaudi::Tr::PID::validated_pid_t::Pion

@ Pion

Definition TrackDefaultParticles.h:22

◆ isProton()

bool Gaudi::Tr::PID::isProton ( ) const

inlineconstexpr

Definition at line 105 of file TrackDefaultParticles.h.

105{ return validated_pid_t::Proton == m_value; }

Gaudi::Tr::PID::validated_pid_t::Proton

@ Proton

Definition TrackDefaultParticles.h:22

◆ Kaon()

constexpr PID Gaudi::Tr::PID::Kaon ( )

inlinestaticconstexpr

Definition at line 58 of file TrackDefaultParticles.h.

58{ return PID{ validated_pid_t::Kaon }; }

◆ mass()

double Gaudi::Tr::PID::mass ( ) const

inlineconstexpr

Definition at line 95 of file TrackDefaultParticles.h.

95{ return s_mass[static_cast<int>( m_value )]; }

Gaudi::Tr::PID::s_mass

static constexpr std::array< double, 5 > s_mass

Definition TrackDefaultParticles.h:23

◆ Muon()

constexpr PID Gaudi::Tr::PID::Muon ( )

inlinestaticconstexpr

Definition at line 54 of file TrackDefaultParticles.h.

54{ return PID{ validated_pid_t::Muon }; }

◆ Pion()

constexpr PID Gaudi::Tr::PID::Pion ( )

inlinestaticconstexpr

Definition at line 56 of file TrackDefaultParticles.h.

56{ return PID{ validated_pid_t::Pion }; }

◆ Proton()

constexpr PID Gaudi::Tr::PID::Proton ( )

inlinestaticconstexpr

Definition at line 60 of file TrackDefaultParticles.h.

60{ return PID{ validated_pid_t::Proton }; }

◆ validate()

constexpr validated_pid_t Gaudi::Tr::PID::validate ( int id )

inlinestaticconstexprprivate

Definition at line 27 of file TrackDefaultParticles.h.

                                                          {
        switch ( id ) {
        case 11:
          return validated_pid_t::Electron;
        case 13:
          return validated_pid_t::Muon;
        case 211:
          return validated_pid_t::Pion;
        case 321:
          return validated_pid_t::Kaon;
        case 2212:
          return validated_pid_t::Proton;
        default:
          throw std::runtime_error( "invalid PID" );
        }
      }

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const PID &	pid )

friend

Definition at line 83 of file TrackDefaultParticles.h.

83{ return toStream( pid, os ); }

Gaudi::Tr::PID::toStream

friend std::ostream & toStream(const PID &pid, std::ostream &os)

Definition TrackDefaultParticles.h:80

◆ parse

StatusCode parse	(	PID &	pid,
		std::string_view	in )

friend

Definition at line 85 of file TrackDefaultParticles.h.

                                                             {
        for ( PID ref : { Electron(), Muon(), Pion(), Kaon(), Proton() } ) {
          if ( in != toString( ref ) ) continue;
          pid = ref;
          return StatusCode::SUCCESS;
        }
        return StatusCode::FAILURE;
      }

◆ toStream

std::ostream & toStream	(	const PID &	pid,
		std::ostream &	os )

friend

Definition at line 80 of file TrackDefaultParticles.h.

                                                                    {
        return os << std::quoted( toString( pid ), '\'' );
      }

◆ toString

const char * toString ( PID pid )

friend

Definition at line 63 of file TrackDefaultParticles.h.

                                             {
        switch ( pid.m_value ) {
        case validated_pid_t::Electron:
          return "Electron";
        case validated_pid_t::Muon:
          return "Muon";
        case validated_pid_t::Pion:
          return "Pion";
        case validated_pid_t::Kaon:
          return "Kaon";
        case validated_pid_t::Proton:
          return "Proton";
        default:
          throw std::runtime_error( "Calling toString on invalid PID" );
        }
      }

Member Data Documentation

◆ m_value

validated_pid_t Gaudi::Tr::PID::m_value

private

Definition at line 25 of file TrackDefaultParticles.h.

◆ s_mass

std::array< double, 5 > Gaudi::Tr::PID::s_mass = { 0.51099891, 105.65837, 139.57018, 493.677, 938.27203 }

staticconstexprprivate

Definition at line 23 of file TrackDefaultParticles.h.

23{ 0.51099891, 105.65837, 139.57018, 493.677, 938.27203 };

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

GaudiPartProp/include/Gaudi/Tr/TrackDefaultParticles.h
GaudiPartProp/src/TrackDefaultParticles.cpp

Public Member Functions

Static Public Member Functions

Private Types

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ validated_pid_t

Constructor & Destructor Documentation

◆ PID() [1/3]

◆ PID() [2/3]

◆ PID() [3/3]

Member Function Documentation

◆ Electron()

◆ isElectron()

◆ isKaon()

◆ isMuon()

◆ isPion()

◆ isProton()

◆ Kaon()

◆ mass()

◆ Muon()

◆ Pion()

◆ Proton()

◆ validate()

Friends And Related Symbol Documentation

◆ operator<<

◆ parse

◆ toStream

◆ toString

Member Data Documentation

◆ m_value

◆ s_mass