Abstract class representing a single result of CCF computation. More...

Inheritance diagram for PARTONS::ConvolCoeffFunctionResult< KinematicType >:

Public Member Functions
virtual	~ConvolCoeffFunctionResult ()
	Destructor. More...

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

void	addResult (GPDType::Type gpdType, const std::complex< double > &result)
	Add result for given GPD type. More...

const std::complex< double > &	getResult (GPDType::Type gpdType) const
	Get reference to result for given GPD type. More...

bool	isAvailable (GPDType::Type gpdType)
	Check if the object stores result associated to given GPD type. More...

std::complex< double >	getLastAvailable () const
	Get reference to result marked by the last call of ConvolCoeffFunctionResult::isAvailible() function. More...

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

std::vector< GPDType >	listGPDTypeComputed () const
	Get list of GPD types associated to stored parton distributions. More...

const std::map< GPDType::Type, std::complex< double > > &	getResultsByGpdType () const
	Get reference to map containing stored results distinguished by associated GPD types. More...

void	setResultsByGpdType (const std::map< GPDType::Type, std::complex< double > > &resultsByGpdType)
	Set map containing stored results distinguished by associated GPD types. More...

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

bool	operator< (const Result< KinematicType > &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 KinematicType &kinematic)
	Set kinematics associated to this result. More...

const KinematicType &	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)

Protected Member Functions
	ConvolCoeffFunctionResult (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...

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

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

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

	Result (const std::string &className, ChannelType::Type channelType, const KinematicType &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
std::map< GPDType::Type, std::complex< double > >	m_resultsByGPDType
	Map containing stored results distinguished by associated GPD types. More...

std::map< GPDType::Type, std::complex< double > >::const_iterator	m_it
	Iterator used to mark a specific entry in ConvolCoeffFunctionResult::m_resultsByGPDType. More...

Protected Attributes inherited from PARTONS::Result< KinematicType >
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...

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

Detailed Description

template<typename KinematicType>
class PARTONS::ConvolCoeffFunctionResult< KinematicType >

Abstract class representing a single result of CCF computation.

This abstract class is used to store results of a single CCF computation.

Constructor & Destructor Documentation

◆ ~ConvolCoeffFunctionResult()

template<typename KinematicType >

virtual PARTONS::ConvolCoeffFunctionResult< KinematicType >::~ConvolCoeffFunctionResult ( )

inlinevirtual

Destructor.

◆ ConvolCoeffFunctionResult() [1/3]

template<typename KinematicType >

PARTONS::ConvolCoeffFunctionResult< KinematicType >::ConvolCoeffFunctionResult	(	const std::string &	className,
		ChannelType::Type	channelType
	)

inlineprotected

Default constructor.

◆ ConvolCoeffFunctionResult() [2/3]

template<typename KinematicType >

PARTONS::ConvolCoeffFunctionResult< KinematicType >::ConvolCoeffFunctionResult	(	const std::string &	className,
		ChannelType::Type	channelType,
		const KinematicType &	kinematic
	)

inlineprotected

Assignment constructor.

Parameters

kinematic CCF kinematics to be assigned.

◆ ConvolCoeffFunctionResult() [3/3]

template<typename KinematicType >

PARTONS::ConvolCoeffFunctionResult< KinematicType >::ConvolCoeffFunctionResult ( const ConvolCoeffFunctionResult< KinematicType > & other )

inlineprotected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ addResult()

template<typename KinematicType >

void PARTONS::ConvolCoeffFunctionResult< KinematicType >::addResult	(	GPDType::Type	gpdType,
		const std::complex< double > &	result
	)

inline

Add result for given GPD type.

Parameters

gpdComputeType	GPD type associated to given result.
result	Result to be added.

◆ compare()

template<typename KinematicType >

void PARTONS::ConvolCoeffFunctionResult< KinematicType >::compare	(	ComparisonReport &	rootComparisonReport,
		const ConvolCoeffFunctionResult< KinematicType > &	referenceObject,
		std::string	parentObjectInfo = `ElemUtils::StringUtils::EMPTY`
	)		const

inline

Compare to other ConvolCoeffFunctionResult 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()

template<typename KinematicType >

std::complex<double> PARTONS::ConvolCoeffFunctionResult< KinematicType >::getLastAvailable ( ) const

inline

Get reference to result marked by the last call of ConvolCoeffFunctionResult::isAvailible() function.

Returns: Reference to selected result.

See also: ConvolCoeffFunctionResult::isAvailible()

◆ getResult()

template<typename KinematicType >

const std::complex<double>& PARTONS::ConvolCoeffFunctionResult< KinematicType >::getResult ( GPDType::Type gpdType ) const

inline

Get reference to result for given GPD type.

Parameters

gpdType GPD type associated to requested result.

Returns: Reference to requested result.

◆ getResultsByGpdType()

template<typename KinematicType >

const std::map<GPDType::Type, std::complex<double> >& PARTONS::ConvolCoeffFunctionResult< KinematicType >::getResultsByGpdType ( ) const

inline

Get reference to map containing stored results distinguished by associated GPD types.

◆ isAvailable()

template<typename KinematicType >

bool PARTONS::ConvolCoeffFunctionResult< KinematicType >::isAvailable ( GPDType::Type gpdType )

inline

Check if the object stores result associated to given GPD type.

Parameters

gpdType GPD type to be checked.

Returns: True if the object stores result associated to given GPD type, otherwise false.

See also: ConvolCoeffFunctionResult::getLastAvailable()

◆ listGPDTypeComputed()

template<typename KinematicType >

std::vector<GPDType> PARTONS::ConvolCoeffFunctionResult< KinematicType >::listGPDTypeComputed ( ) const

inline

Get list of GPD types associated to stored parton distributions.

Returns: Vector of associated types.

◆ setResultsByGpdType()

template<typename KinematicType >

void PARTONS::ConvolCoeffFunctionResult< KinematicType >::setResultsByGpdType ( const std::map< GPDType::Type, std::complex< double > > & resultsByGpdType )

inline

Set map containing stored results distinguished by associated GPD types.

◆ toString()

template<typename KinematicType >

virtual std::string PARTONS::ConvolCoeffFunctionResult< KinematicType >::toString ( ) const

inlinevirtual

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

Returns: a pre-formatted characters string.

Reimplemented from PARTONS::Result< KinematicType >.

Member Data Documentation

◆ m_it

template<typename KinematicType >

std::map<GPDType::Type, std::complex<double> >::const_iterator PARTONS::ConvolCoeffFunctionResult< KinematicType >::m_it

protected

Iterator used to mark a specific entry in ConvolCoeffFunctionResult::m_resultsByGPDType.

◆ m_resultsByGPDType

template<typename KinematicType >

std::map<GPDType::Type, std::complex<double> > PARTONS::ConvolCoeffFunctionResult< KinematicType >::m_resultsByGPDType

protected

Map containing stored results distinguished by associated GPD types.

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

include/partons/beans/convol_coeff_function/ConvolCoeffFunctionResult.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename KinematicType> class PARTONS::ConvolCoeffFunctionResult< KinematicType >

Constructor & Destructor Documentation

◆ ~ConvolCoeffFunctionResult()

◆ ConvolCoeffFunctionResult() [1/3]

◆ ConvolCoeffFunctionResult() [2/3]

◆ ConvolCoeffFunctionResult() [3/3]

Member Function Documentation

◆ addResult()

◆ compare()

◆ getLastAvailable()

◆ getResult()

◆ getResultsByGpdType()

◆ isAvailable()

◆ listGPDTypeComputed()

◆ setResultsByGpdType()

◆ toString()

Member Data Documentation

◆ m_it

◆ m_resultsByGPDType

template<typename KinematicType>
class PARTONS::ConvolCoeffFunctionResult< KinematicType >