Class representing single result of a collinear-distribution computation. More...

Inheritance diagram for PARTONS::CollinearDistributionResult:

Public Member Functions
	CollinearDistributionResult ()
	Default constructor. More...

	CollinearDistributionResult (const CollinearDistributionKinematic &kinematic)
	Assignment constructor. More...

	CollinearDistributionResult (const CollinearDistributionResult &other)
	Copy constructor. More...

virtual	~CollinearDistributionResult ()
	Destructor. More...

virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...

void	addPartonDistribution (CollinearDistributionType::Type colldistType, const PartonDistribution &partonDistribution)
	Add parton distribution associated to given collinear distribution type. More...

const PartonDistribution &	getPartonDistribution (CollinearDistributionType::Type colldistType) const
	Get reference to parton distribution associated to given collinear distribution type. More...

bool	isAvailable (const CollinearDistributionType::Type &colldistType) const
	Check if the object stores parton distribution of given collinear distribution type. More...

PartonDistribution &	getLastAvailable () const
	Get reference to parton distribution marked by the last call of CollinearDistributionResult::isAvailible() function. More...

void	compare (ComparisonReport &rootComparisonReport, const CollinearDistributionResult &referenceObject, std::string parentObjectInfo="") const
	Compare to other CollinearDistributionResult object and store comparison result in given comparison report. More...

std::vector< CollinearDistributionType >	listCollinearDistributionTypeComputed () const
	Get list of collinear distribution types associated to stored parton distributions. More...

const std::map< CollinearDistributionType::Type, PartonDistribution > &	getPartonDistributions () const
	Get reference to map containing stored parton distributions distinguished by associated collinear distribution types. More...

void	setPartonDistributions (const std::map< CollinearDistributionType::Type, PartonDistribution > &partonDistributions)
	Set map containing stored parton distributions distinguished by associated collinear distribution types. More...

Public Member Functions inherited from PARTONS::Result< CollinearDistributionKinematic >
virtual	~Result ()
	Destructor. More...

bool	operator< (const Result< CollinearDistributionKinematic > &other) const
	Relation operator that checks if the value of left operand is less than the value of right operand (in this case returned is this->m_kinematic < other.m_kinematic). More...

ChannelType::Type	getChannelType () const
	Get channel type. More...

void	setComputationModuleName (const std::string &moduleName)
	Set name of module used to evaluate this result. More...

const std::string &	getComputationModuleName () const
	Get name of module used to evaluate this result. More...

void	setResultInfo (const ResultInfo &resultInfo)
	Set information on this result. More...

const ResultInfo &	getResultInfo () const
	Get information on this result. More...

void	setKinematic (const CollinearDistributionKinematic &kinematic)
	Set kinematics associated to this result. More...

const CollinearDistributionKinematic &	getKinematic () const
	Get reference to kinematics associated to this result. 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)

Private Attributes
std::map< CollinearDistributionType::Type, PartonDistribution >	m_partonDistributions
	Map containing stored parton distributions distinguished by associated collinear distribution types. More...

std::map< CollinearDistributionType::Type, PartonDistribution >::const_iterator	m_it
	Iterator used to mark a specific entry in CollinearDistributionResult::m_partonDistributions. More...

Additional Inherited Members
Protected Member Functions inherited from PARTONS::Result< CollinearDistributionKinematic >
	Result (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...

	Result (const std::string &className, ChannelType::Type channelType, const CollinearDistributionKinematic &kinematic)
	Assignment constructor. More...

	Result (const Result &other)
	Copy constructor. More...

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...

Protected Attributes inherited from PARTONS::Result< CollinearDistributionKinematic >
ChannelType::Type	m_channelType
	Channel type. More...

std::string	m_computationModuleName
	Name of module used to evaluate this result. More...

ResultInfo	m_resultInfo
	Information on this result. More...

CollinearDistributionKinematic	m_kinematic
	Kinematics associated to this result. More...

Detailed Description

Class representing single result of a collinear-distribution computation.

This class is used to store results of a single collinear distribution computation. In other words, the class stores a collection of PartonDistribution objects, with each of them containing a part of the result defined for a specific collinear distribution type.

Constructor & Destructor Documentation

◆ CollinearDistributionResult() [1/3]

PARTONS::CollinearDistributionResult::CollinearDistributionResult ( )

Default constructor.

◆ CollinearDistributionResult() [2/3]

PARTONS::CollinearDistributionResult::CollinearDistributionResult ( const CollinearDistributionKinematic & kinematic )

Assignment constructor.

Parameters

kinematic collinear distribution kinematics to be assigned.

◆ CollinearDistributionResult() [3/3]

PARTONS::CollinearDistributionResult::CollinearDistributionResult ( const CollinearDistributionResult & other )

Copy constructor.

Parameters

other Object to be copied.

◆ ~CollinearDistributionResult()

PARTONS::CollinearDistributionResult::~CollinearDistributionResult ( )

virtual

Destructor.

Member Function Documentation

◆ addPartonDistribution()

void PARTONS::CollinearDistributionResult::addPartonDistribution	(	CollinearDistributionType::Type	colldistType,
		const PartonDistribution &	partonDistribution
	)

Add parton distribution associated to given collinear distribution type.

Parameters

colldistType	collinear distribution type of parton distribution to be inserted.
partonDistribution	Parton distribution to be added.

◆ compare()

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

Compare to other CollinearDistributionResult 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).

◆ getLastAvailable()

PartonDistribution & PARTONS::CollinearDistributionResult::getLastAvailable ( ) const

Get reference to parton distribution marked by the last call of CollinearDistributionResult::isAvailible() function.

Returns: Reference to selected parton distribution.

See also: CollinearDistributionResult::isAvailible()

◆ getPartonDistribution()

const PartonDistribution & PARTONS::CollinearDistributionResult::getPartonDistribution ( CollinearDistributionType::Type colldistType ) const

Get reference to parton distribution associated to given collinear distribution type.

Parameters

colldistType collinear distribution type associated to parton distribution to be selected.

Returns: Reference to selected parton distribution.

◆ getPartonDistributions()

const std::map< CollinearDistributionType::Type, PartonDistribution > & PARTONS::CollinearDistributionResult::getPartonDistributions ( ) const

Get reference to map containing stored parton distributions distinguished by associated collinear distribution types.

◆ isAvailable()

bool PARTONS::CollinearDistributionResult::isAvailable ( const CollinearDistributionType::Type & colldistType ) const

Check if the object stores parton distribution of given collinear distribution type.

Parameters

colldistType collinear distribution type to be checked.

Returns: True if the object stores parton distribution of given collinear distribution type, otherwise false.

See also: CollinearDistributionResult::getLastAvailable()

◆ listCollinearDistributionTypeComputed()

std::vector< CollinearDistributionType > PARTONS::CollinearDistributionResult::listCollinearDistributionTypeComputed ( ) const

Get list of collinear distribution types associated to stored parton distributions.

Returns: Vector of associated types.

◆ setPartonDistributions()

void PARTONS::CollinearDistributionResult::setPartonDistributions ( const std::map< CollinearDistributionType::Type, PartonDistribution > & partonDistributions )

Set map containing stored parton distributions distinguished by associated collinear distribution types.

◆ toString()

std::string PARTONS::CollinearDistributionResult::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::Result< CollinearDistributionKinematic >.

Member Data Documentation

◆ m_it

std::map<CollinearDistributionType::Type, PartonDistribution>::const_iterator PARTONS::CollinearDistributionResult::m_it

mutableprivate

Iterator used to mark a specific entry in CollinearDistributionResult::m_partonDistributions.

◆ m_partonDistributions

std::map<CollinearDistributionType::Type, PartonDistribution> PARTONS::CollinearDistributionResult::m_partonDistributions

private

Map containing stored parton distributions distinguished by associated collinear distribution types.

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

include/partons/beans/collinear_distribution/CollinearDistributionResult.h
src/partons/beans/collinear_distribution/CollinearDistributionResult.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CollinearDistributionResult() [1/3]

◆ CollinearDistributionResult() [2/3]

◆ CollinearDistributionResult() [3/3]

◆ ~CollinearDistributionResult()

Member Function Documentation

◆ addPartonDistribution()

◆ compare()

◆ getLastAvailable()

◆ getPartonDistribution()

◆ getPartonDistributions()

◆ isAvailable()

◆ listCollinearDistributionTypeComputed()

◆ setPartonDistributions()

◆ toString()

Member Data Documentation

◆ m_it

◆ m_partonDistributions