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

Definition of enumeration values for collinear distribution types. More...

Public Types

enum  Type {
  UNDEFINED = 0 , ALL = 1 , UnpolPDF = 2 , PolPDF = 3 ,
  TransPDF = 4 , UnpolFF = 5 , PolFF = 6 , TransFF = 7 ,
  END
}
 Definition of enumerate values corresponding to collinear-distribution types. More...
 

Public Member Functions

 CollinearDistributionType ()
 Default constructor. More...
 
 CollinearDistributionType (Type type)
 Assignment constructor. More...
 
 CollinearDistributionType (const CollinearDistributionType &other)
 Copy constructor. More...
 
 operator Type () const
 Automatic cast to enum. 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 CollinearDistributionType &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 CollinearDistributionType::Type). More...
 
CollinearDistributionType::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 CollinearDistributionType::Type fromString (const std::string &colldistTypeStr)
 Try to match collinear distribution type from given string. More...
 
static List< CollinearDistributionTypegetListOfCollinearDistributionTypeFromString (const std::string &colldistTypeListAsString)
 Try to match list of collinear distribution types from given string. More...
 

Static Public Attributes

static const std::string COLLINEAR_DISTRIBUTION_TYPE_DB_COLUMN_NAME = "collinear_distribution_type"
 Name of table in the database corresponding to this class. More...
 

Private Attributes

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

Detailed Description

Definition of enumeration values for collinear distribution types.

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

Member Enumeration Documentation

◆ Type

Definition of enumerate values corresponding to collinear-distribution types.

Enumerator
UNDEFINED 

Undefined type.

ALL 

All-like type, useful to indicate all available types.

UnpolPDF 

Twist-2 collinear unpolarised PDFs.

PolPDF 

Twist-2 collinear logitudinally polarised PDFs.

TransPDF 

Twist-2 collinear transversely polarised PDFs.

UnpolFF 

Twist-2 collinear unpolarised FFs.

PolFF 

Twist-2 collinear logitudinally polarised FFs.

TransFF 

Twist-2 collinear transversely polarised FFs.

END 

End-like type, useful to define loops over all types.

Constructor & Destructor Documentation

◆ CollinearDistributionType() [1/3]

PARTONS::CollinearDistributionType::CollinearDistributionType ( )

Default constructor.

◆ CollinearDistributionType() [2/3]

PARTONS::CollinearDistributionType::CollinearDistributionType ( Type  type)

Assignment constructor.

Parameters
typeType to be assigned.

◆ CollinearDistributionType() [3/3]

PARTONS::CollinearDistributionType::CollinearDistributionType ( const CollinearDistributionType other)

Copy constructor.

Parameters
otherObject to be copied.
other

Member Function Documentation

◆ fromString()

CollinearDistributionType::Type PARTONS::CollinearDistributionType::fromString ( const std::string &  colldistTypeStr)
static

Try to match collinear distribution type from given string.

Parameters
colldistTypeStrString to be matched.
Returns
Matched type or CollinearDistributionType::UNDEFINED if unable to match.

◆ getListOfCollinearDistributionTypeFromString()

List< CollinearDistributionType > PARTONS::CollinearDistributionType::getListOfCollinearDistributionTypeFromString ( const std::string &  colldistTypeListAsString)
static

Try to match list of collinear distribution types from given string.

Types should be separated by the pipe symbol, e.g. "H|E|..."

Parameters
colldistTypeListAsStringString to be matched.
Returns
List of matched CollinearDistributionType objects.

◆ getType()

CollinearDistributionType::Type PARTONS::CollinearDistributionType::getType ( ) const

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

◆ operator Type()

PARTONS::CollinearDistributionType::operator CollinearDistributionType::Type ( ) const

Automatic cast to enum.

◆ operator<()

bool PARTONS::CollinearDistributionType::operator< ( const CollinearDistributionType 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 CollinearDistributionType::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::CollinearDistributionType::serialize ( ElemUtils::Packet &  packet) const

Serialize into given Packet.

Parameters
packetTarget Packet.

◆ setType()

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

Assign type to a declared object of this class.

◆ toString()

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

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

Returns
String representation of assigned type, like "H" for CollinearDistributionType::H.

◆ unserialize()

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

Retrieve data from given Packet.

Parameters
packetInput Packet.

Member Data Documentation

◆ COLLINEAR_DISTRIBUTION_TYPE_DB_COLUMN_NAME

const std::string PARTONS::CollinearDistributionType::COLLINEAR_DISTRIBUTION_TYPE_DB_COLUMN_NAME = "collinear_distribution_type"
static

Name of table in the database corresponding to this class.

◆ m_type

CollinearDistributionType::Type PARTONS::CollinearDistributionType::m_type
private

Type associated to a declared object of this class.


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