EPIC::ParticleCodeType Class Reference

Definition of enumeration values for particle types. More...

#include <ParticleCodeType.h>

Inheritance diagram for EPIC::ParticleCodeType:

Public Types
enum	Type {   UNDEFINED = 0 , UNDECAYED = 1 , DECAYED = 2 , DOCUMENTATION = 3 ,   BEAM = 4 , SCATTERED = 5 , VIRTUAL = 6 }

Public Member Functions
	ParticleCodeType ()
	ParticleCodeType (Type type)
	ParticleCodeType (const ParticleCodeType &other)
	operator Type () const
std::string	toString () const
ParticleCodeType::Type	getType () const
void	setType (Type type)

Static Public Member Functions
static ParticleCodeType::Type	fromString (const std::string &str)

Detailed Description

Definition of enumeration values for particle types.

This class defines a set of enumeration values that are used to distinguish between particle code types. In addition, a declared object of this class is always associated to one type (see ParticleCodeType::m_type), so member functions can act on it.

Member Enumeration Documentation

Type

enum EPIC::ParticleCodeType::Type

Definition of enumerate values corresponding to particle code types. According to Table 5 from https://arxiv.org/pdf/1912.08005.pdf

Enumerator
UNDEFINED	Undefined type.
UNDECAYED	Undecayed.
DECAYED	Decayed.
DOCUMENTATION	Documentation.
BEAM	Beam.
SCATTERED	Scattered beam.
VIRTUAL	Virtual.

Constructor & Destructor Documentation

ParticleCodeType() [1/3]

EPIC::ParticleCodeType::ParticleCodeType

(

)

Default constructor.

ParticleCodeType() [2/3]

EPIC::ParticleCodeType::ParticleCodeType

(

Type

type

)

Assignment constructor.

Parameters

type	Type to be assigned.

ParticleCodeType() [3/3]

EPIC::ParticleCodeType::ParticleCodeType

(

const ParticleCodeType &

other

)

Copy constructor.

Parameters

other

Object to be copied.

Member Function Documentation

fromString()

static ParticleCodeType::Type EPIC::ParticleCodeType::fromString ( const std::string &  str )

static

Get type from string.

Parameters

String.

Returns

Associated type.

getType()

ParticleCodeType::Type EPIC::ParticleCodeType::getType

(

)

const

Get type being assigned to a declared object of this class.

operator Type()

EPIC::ParticleCodeType::operator Type

(

)

const

Automatic cast to enum.

setType()

void EPIC::ParticleCodeType::setType

(

Type

type

)

Assign type to a declared object of this class.

---

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

• /Users/pawel/projects/epic/NEW2/epic/include/beans/types/ParticleCodeType.h