PARTONS::GluonDistribution Class Reference

Container to store value of single gluon distribution. More...

Inheritance diagram for PARTONS::GluonDistribution:

Public Member Functions
	GluonDistribution ()
	Default constructor. More...
	GluonDistribution (const GluonDistribution &other)
	Copy constructor. More...
	GluonDistribution (double gluonDistribution)
	Assignment constructor. More...
virtual	~GluonDistribution ()
	Destructor. More...
virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...
void	compare (ComparisonReport &rootComparisonReport, const GluonDistribution &referenceObject, std::string parentObjectInfo="") const
	Compare to other GluonDistribution object and store comparison result in given comparison report. More...
double	getGluonDistribution () const
	Get value of gluon distribution. More...
void	setGluonDistribution (double gluonDistribution)
	Set value of gluon distribution. More...
bool	isNullObject () const
	Check if any value of gluon distribution has been set. More...
void	setNullObject (bool nullObject)
	Set GluonDistribution::m_nullObject. More...
Public Member Functions inherited from PARTONS::BaseObject
	BaseObject (const std::string &className)
	Constructor. More...
virtual	~BaseObject ()
	Default destructor. More...
virtual BaseObject *	clone () const
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
virtual void	resolveObjectDependencies ()
	Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others. More...
void	serialize (ElemUtils::Packet &packet) const
	Used to split a complex C++ object into a concatenation of simple types. More...
void	unserialize (ElemUtils::Packet &packet)
	Used to rebuild a complex C++ object from a concatenation of simple type. More...
bool	operator< (const BaseObject &other) const
	Overload of < operator to sort BaseObject object by its indexId value. More...
const std::string &	getClassName () const
unsigned int	getObjectId () const
int	getIndexId () const
void	setIndexId (int indexId)

Static Public Attributes
static const std::string	GLUON_DISTRIBUTION_DB_COLUMN_NAME
	Name of field in the database storing value of gluon distribution. More...
static const std::string	GLUON_DISTRIBUTION_PARAMETER_NAME_GLUON_DISTRIBUTION

Private Attributes
double	m_gluonDistribution
	Value of gluon distribution. More...
bool	m_nullObject
	Variable to check if any value of gluon distribution has been set. More...

Additional Inherited Members
Protected Member Functions inherited from PARTONS::BaseObject
	BaseObject (const BaseObject &other)
	Copy constructor. More...
void	info (const std::string &functionName, const std::string &message) const
	Print info message into logger. More...
void	debug (const std::string &functionName, const std::string &message) const
	Print debug message into logger. More...
void	warn (const std::string &functionName, const std::string &message) const
	Print warning message into logger. More...
void	errorMissingParameter (const std::string &parameterName) const
	Use in automation process to throw exception when a parameter is missing from the XML scenario file. More...

Detailed Description

Container to store value of single gluon distribution.

This class represents a gluon distribution at a single kinematic point. For example, it can be a gluon GPD of a given type at some GPD kinematics.

To see how this class can be used, analyze the following example:

//in code, e.g. in one of GPD modules, one calculates value of GPD H for gluons at given kinematics
double Hg = 3.45;
 
//store this result in GluonDistribution object
GluonDistribution gluonDistribution(Hg);
 
//check what is inside
Partons::getInstance()->getLoggerManager()->info("example", __func__, ElemUtils::Formatter() << "Gluon distribution contains: " << gluonDistribution.toString());

which gives via Logger:

20-05-2017 08:51:19 [INFO] (example::main) Gluon distribution contains: GluonDistribution = 3.45

Check also the documentation of GPDResult and PartonDistribution classes, where GluonDistribution objects are used extensively.

Constructor & Destructor Documentation

GluonDistribution() [1/3]

PARTONS::GluonDistribution::GluonDistribution

(

)

Default constructor.

GluonDistribution() [2/3]

PARTONS::GluonDistribution::GluonDistribution

(

const GluonDistribution &

other

)

Copy constructor.

Parameters

other

Object to be copied.

GluonDistribution() [3/3]

PARTONS::GluonDistribution::GluonDistribution

(

double

gluonDistribution

)

Assignment constructor.

Parameters

gluonDistribution

Value to be assigned.

~GluonDistribution()

PARTONS::GluonDistribution::~GluonDistribution ( )

virtual

Destructor.

Member Function Documentation

compare()

void PARTONS::GluonDistribution::compare	(	ComparisonReport &	rootComparisonReport,
		const GluonDistribution &	referenceObject,
		std::string	parentObjectInfo = ""
	)		const

Compare to other GluonDistribution object and store comparison result in given comparison report.

Parameters

rootComparisonReport	Reference to comparison report to be used to store comparison result.
referenceObject	Reference to object to be compared.
parentObjectInfo	Addition information coming from the parent object (if needed).

getGluonDistribution()

double PARTONS::GluonDistribution::getGluonDistribution

(

)

const

Get value of gluon distribution.

isNullObject()

bool PARTONS::GluonDistribution::isNullObject

(

)

const

Check if any value of gluon distribution has been set.

setGluonDistribution()

void PARTONS::GluonDistribution::setGluonDistribution

(

double

gluonDistribution

)

Set value of gluon distribution.

setNullObject()

void PARTONS::GluonDistribution::setNullObject

(

bool

nullObject

)

Set GluonDistribution::m_nullObject.

toString()

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

virtual

Return a pre-formatted characters string for output visualization of class member's values.

Returns

a pre-formatted characters string.

Reimplemented from PARTONS::BaseObject.

Member Data Documentation

GLUON_DISTRIBUTION_DB_COLUMN_NAME

const std::string PARTONS::GluonDistribution::GLUON_DISTRIBUTION_DB_COLUMN_NAME

static

Initial value:

=
        "gluon_distribution"

Name of field in the database storing value of gluon distribution.

GLUON_DISTRIBUTION_PARAMETER_NAME_GLUON_DISTRIBUTION

const std::string PARTONS::GluonDistribution::GLUON_DISTRIBUTION_PARAMETER_NAME_GLUON_DISTRIBUTION

static

Initial value:

=
        "gluon_distribution"

m_gluonDistribution

double PARTONS::GluonDistribution::m_gluonDistribution

private

Value of gluon distribution.

m_nullObject

bool PARTONS::GluonDistribution::m_nullObject

private

Variable to check if any value of gluon distribution has been set.

---

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

• include/partons/beans/parton_distribution/GluonDistribution.h
• src/partons/beans/parton_distribution/GluonDistribution.cpp