PARTONS  
PARtonic Tomography Of Nucleon Software
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
PARTONS::MesonType Class Reference

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

Public Types

enum  Type {
  UNDEFINED = 0 , RHOMINUS = 1 , RHO0 = 2 , RHOPLUS = 3 ,
  OMEGA = 4 , PHI = 5 , JPSI = 6 , UPSILON = 7 ,
  PIMINUS = 8 , PI0 = 9 , PIPLUS = 10
}
 Definition of enumerate values corresponding to meson types. More...
 

Public Member Functions

 MesonType ()
 Default constructor. More...
 
 MesonType (Type type)
 Assignment constructor. More...
 
 MesonType (const MesonType &other)
 Copy constructor. More...
 
 operator Type () const
 Automatic cast to enum. More...
 
List< GPDTypegetPossibleGPDTypes () const
 Get list of GPD types probed by the meson. More...
 
double getMass () const
 Get mass associated to set meson type. More...
 
std::string toString () const
 Get string representation of type being assigned to a declared object of this class. More...
 
void serialize (ElemUtils::Packet &packet) const
 Serialize into given Packet. More...
 
void unserialize (ElemUtils::Packet &packet)
 Retrieve data from given Packet. More...
 
bool operator< (const MesonType &other) const
 Relation operator that checks if the value of left operand is less than the value of right operand (based on values assigned in the definition of MesonType::Type). More...
 
MesonType::Type getType () const
 Get type being assigned to a declared object of this class. More...
 
void setType (Type type)
 Assign type to a declared object of this class. More...
 

Static Public Member Functions

static MesonType::Type fromString (const std::string &mesonTypeStr)
 Try to match meson type from given string. More...
 

Private Attributes

MesonType::Type m_type
 Type associated to a declared object of this class. More...
 

Detailed Description

Definition of enumeration values for meson types.

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

Member Enumeration Documentation

◆ Type

Definition of enumerate values corresponding to meson types.

Enumerator
UNDEFINED 

Undefined type.

RHOMINUS 

\(\rho^{-}\)

RHO0 

\(\rho^{0}\)

RHOPLUS 

\(\rho^{+}\)

OMEGA 

\(\omega\)

PHI 

\(\phi\)

JPSI 

\(J/\Psi\)

UPSILON 

\(\Upsilon\)

PIMINUS 

\(\pi^{-}\)

PI0 

\(\pi^{0}\)

PIPLUS 

\(\pi^{+}\)

Constructor & Destructor Documentation

◆ MesonType() [1/3]

PARTONS::MesonType::MesonType ( )

Default constructor.

◆ MesonType() [2/3]

PARTONS::MesonType::MesonType ( Type  type)

Assignment constructor.

Parameters
typeType to be assigned.

◆ MesonType() [3/3]

PARTONS::MesonType::MesonType ( const MesonType other)

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ fromString()

MesonType::Type PARTONS::MesonType::fromString ( const std::string &  mesonTypeStr)
static

Try to match meson type from given string.

Parameters
mesonTypeStrString to be matched.
Returns
Matched type or MesonType::UNDEFINED if unable to match.

◆ getMass()

double PARTONS::MesonType::getMass ( ) const

Get mass associated to set meson type.

◆ getPossibleGPDTypes()

List< GPDType > PARTONS::MesonType::getPossibleGPDTypes ( ) const

Get list of GPD types probed by the meson.

◆ getType()

MesonType::Type PARTONS::MesonType::getType ( ) const

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

◆ operator Type()

PARTONS::MesonType::operator MesonType::Type ( ) const

Automatic cast to enum.

◆ operator<()

bool PARTONS::MesonType::operator< ( const MesonType other) const

Relation operator that checks if the value of left operand is less than the value of right operand (based on values assigned in the definition of MesonType::Type).

Used by std::sort function.

Parameters
otherRight hand value.
Returns
True if the value of left operand is less than the value of right operand, otherwise false.

◆ serialize()

void PARTONS::MesonType::serialize ( ElemUtils::Packet &  packet) const

Serialize into given Packet.

Parameters
packetTarget Packet.

◆ setType()

void PARTONS::MesonType::setType ( Type  type)

Assign type to a declared object of this class.

◆ toString()

std::string PARTONS::MesonType::toString ( ) const

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

Returns
String representation of assigned type.

◆ unserialize()

void PARTONS::MesonType::unserialize ( ElemUtils::Packet &  packet)

Retrieve data from given Packet.

Parameters
packetInput Packet.

Member Data Documentation

◆ m_type

MesonType::Type PARTONS::MesonType::m_type
private

Type associated to a declared object of this class.


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