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

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

Public Types

enum  Type {
  UNDEFINED = 0 , ALL = 1 , H = 2 , E = 3 ,
  Ht = 4 , Et = 5 , HTrans = 6 , ETrans = 7 ,
  HtTrans = 8 , EtTrans = 9 , H3p = 10 , E3p = 11 ,
  Ht3p = 12 , Et3p = 13 , H3m = 14 , E3m = 15 ,
  Ht3m = 16 , Et3m = 17 , EbarTrans = 18 , HL = 19 ,
  EL = 20 , END
}
 Definition of enumerate values corresponding to GPD types. More...
 

Public Member Functions

 GPDType ()
 Default constructor. More...
 
 GPDType (Type type)
 Assignment constructor. More...
 
 GPDType (const GPDType &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 GPDType &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 GPDType::Type). More...
 
GPDType::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 GPDType::Type fromString (const std::string &gpdTypeStr)
 Try to match GPD type from given string. More...
 
static List< GPDTypegetListOfGPDTypeFromString (const std::string &gpdTypeListAsString)
 Try to match list of GPD types from given string. More...
 

Private Attributes

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

Detailed Description

Definition of enumeration values for GPD types.

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

Member Enumeration Documentation

◆ Type

Definition of enumerate values corresponding to GPD types.

Enumerator
UNDEFINED 

Undefined type.

ALL 

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

Twist-2 GPD \(H\).

Twist-2 GPD \(E\).

Ht 

Twist-2 GPD \(\tilde{H}\).

Et 

Twist-2 GPD \(\tilde{E}\).

HTrans 

Twist-2 GPD \(H_{T}\).

ETrans 

Twist-2 GPD \(E_{T}\).

HtTrans 

Twist-2 GPD \(\tilde{H}_{T}\).

EtTrans 

Twist-2 GPD \(\tilde{E}_{T}\).

H3p 

Twist-3 GPD \(H_{3}^{+}\).

E3p 

Twist-3 GPD \(E_{3}^{+}\).

Ht3p 

Twist-3 GPD \(\tilde{H}_{3}^{+}\).

Et3p 

Twist-3 GPD \(\tilde{E}_{3}^{+}\).

H3m 

Twist-3 GPD \(H_{3}^{-}\).

E3m 

Twist-3 GPD \(E_{3}^{-}\).

Ht3m 

Twist-3 GPD \(\tilde{H}_{3}^{-}\).

Et3m 

Twist-3 GPD \(\tilde{E}_{3}^{-}\).

EbarTrans 

\(2\tilde{H}_{T} + E_{T}\)

HL 

Used in DDVCS to mark CFF longitudinal helicity amplitudes related to GPD H.

EL 

Used in DDVCS to mark CFF longitudinal helicity amplitudes related to GPD E.

END 

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

Constructor & Destructor Documentation

◆ GPDType() [1/3]

PARTONS::GPDType::GPDType ( )

Default constructor.

◆ GPDType() [2/3]

PARTONS::GPDType::GPDType ( Type  type)

Assignment constructor.

Parameters
typeType to be assigned.

◆ GPDType() [3/3]

PARTONS::GPDType::GPDType ( const GPDType other)

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ fromString()

GPDType::Type PARTONS::GPDType::fromString ( const std::string &  gpdTypeStr)
static

Try to match GPD type from given string.

Parameters
gpdTypeStrString to be matched.
Returns
Matched type or GPDType::UNDEFINED if unable to match.

◆ getListOfGPDTypeFromString()

List< GPDType > PARTONS::GPDType::getListOfGPDTypeFromString ( const std::string &  gpdTypeListAsString)
static

Try to match list of GPD types from given string.

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

Parameters
gpdTypeListAsStringString to be matched.
Returns
List of matched GPDType objects.

◆ getType()

GPDType::Type PARTONS::GPDType::getType ( ) const

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

◆ operator Type()

PARTONS::GPDType::operator GPDType::Type ( ) const

Automatic cast to enum.

◆ operator<()

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

Serialize into given Packet.

Parameters
packetTarget Packet.

◆ setType()

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

Assign type to a declared object of this class.

◆ toString()

std::string PARTONS::GPDType::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 GPDType::H.

◆ unserialize()

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

Retrieve data from given Packet.

Parameters
packetInput Packet.

Member Data Documentation

◆ m_type

GPDType::Type PARTONS::GPDType::m_type
private

Type associated to a declared object of this class.


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