Abstract class representing single observable result. More...

Inheritance diagram for PARTONS::ObservableResult< KinematicType >:

Public Member Functions
virtual	~ObservableResult ()
	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 ObservableResult &referenceObject, std::string parentObjectInfo=ElemUtils::StringUtils::EMPTY) const
	Compare to other DVCSConvolCoeffFunctionResult object and store comparison result in given comparison report. More...

const PhysicalType< double > &	getValue () const
	Get value of result. More...

void	setValue (const PhysicalType< double > &value)
	Set value of result. More...

const ErrorBar< double > &	getErrStat () const
	Get statistical uncertainty. More...

void	setErrStat (const ErrorBar< double > &errStat)
	Set statistical uncertainty. More...

const ErrorBar< double > &	getErrSys () const
	Get systematic uncertainty. More...

void	setErrSys (const ErrorBar< double > &errSys)
	Set systematic uncertainty. More...

const ErrorBar< double > &	getErrScale () const
	Get scale uncertainty. More...

void	setErrScale (const ErrorBar< double > &errScale)
	Set scale uncertainty. More...

const std::string &	getExperimentalDataSetName () const
	Get data set name. More...

void	setExperimentalDataSetName (const std::string &experimentalDataSetName)
	Set data set name. 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
	ObservableResult (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...

	ObservableResult (const std::string &className, ChannelType::Type channelType, const PhysicalType< double > &value)
	Assignment constructor. More...

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

	ObservableResult (const std::string &className, ChannelType::Type channelType, const PhysicalType< double > &value, const KinematicType &kinematic)
	Assignment constructor. More...

	ObservableResult (const ObservableResult &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
PhysicalType< double >	m_value
	Value of result. More...

ErrorBar< double >	m_errStat
	Statistical error. More...

ErrorBar< double >	m_errSys
	Systematic error. More...

ErrorBar< double >	m_errScale
	Systematic error. More...

std::string	m_experimentalDataSetName
	Data set name. 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::ObservableResult< KinematicType >

Abstract class representing single observable result.

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

Constructor & Destructor Documentation

◆ ~ObservableResult()

template<typename KinematicType >

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

inlinevirtual

Destructor.

◆ ObservableResult() [1/5]

template<typename KinematicType >

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

inlineprotected

Default constructor.

◆ ObservableResult() [2/5]

template<typename KinematicType >

PARTONS::ObservableResult< KinematicType >::ObservableResult	(	const std::string &	className,
		ChannelType::Type	channelType,
		const PhysicalType< double > &	value
	)

inlineprotected

Assignment constructor.

Parameters

value Value to be assigned.

◆ ObservableResult() [3/5]

template<typename KinematicType >

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

inlineprotected

Assignment constructor.

Parameters

kinematic Observable kinematics to be assigned.

◆ ObservableResult() [4/5]

template<typename KinematicType >

PARTONS::ObservableResult< KinematicType >::ObservableResult	(	const std::string &	className,
		ChannelType::Type	channelType,
		const PhysicalType< double > &	value,
		const KinematicType &	kinematic
	)

inlineprotected

Assignment constructor.

Parameters

value	Value to be assigned.
kinematic	Observable kinematics to be assigned.

◆ ObservableResult() [5/5]

template<typename KinematicType >

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

inlineprotected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ compare()

template<typename KinematicType >

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

inline

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

◆ getErrScale()

template<typename KinematicType >

const ErrorBar<double>& PARTONS::ObservableResult< KinematicType >::getErrScale ( ) const

inline

Get scale uncertainty.

◆ getErrStat()

template<typename KinematicType >

const ErrorBar<double>& PARTONS::ObservableResult< KinematicType >::getErrStat ( ) const

inline

Get statistical uncertainty.

◆ getErrSys()

template<typename KinematicType >

const ErrorBar<double>& PARTONS::ObservableResult< KinematicType >::getErrSys ( ) const

inline

Get systematic uncertainty.

◆ getExperimentalDataSetName()

template<typename KinematicType >

const std::string& PARTONS::ObservableResult< KinematicType >::getExperimentalDataSetName ( ) const

inline

Get data set name.

◆ getValue()

template<typename KinematicType >

const PhysicalType<double>& PARTONS::ObservableResult< KinematicType >::getValue ( ) const

inline

Get value of result.

◆ setErrScale()

template<typename KinematicType >

void PARTONS::ObservableResult< KinematicType >::setErrScale ( const ErrorBar< double > & errScale )

inline

Set scale uncertainty.

◆ setErrStat()

template<typename KinematicType >

void PARTONS::ObservableResult< KinematicType >::setErrStat ( const ErrorBar< double > & errStat )

inline

Set statistical uncertainty.

◆ setErrSys()

template<typename KinematicType >

void PARTONS::ObservableResult< KinematicType >::setErrSys ( const ErrorBar< double > & errSys )

inline

Set systematic uncertainty.

◆ setExperimentalDataSetName()

template<typename KinematicType >

void PARTONS::ObservableResult< KinematicType >::setExperimentalDataSetName ( const std::string & experimentalDataSetName )

inline

Set data set name.

◆ setValue()

template<typename KinematicType >

void PARTONS::ObservableResult< KinematicType >::setValue ( const PhysicalType< double > & value )

inline

Set value of result.

◆ toString()

template<typename KinematicType >

virtual std::string PARTONS::ObservableResult< 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_errScale

template<typename KinematicType >

ErrorBar<double> PARTONS::ObservableResult< KinematicType >::m_errScale

protected

Systematic error.

◆ m_errStat

template<typename KinematicType >

ErrorBar<double> PARTONS::ObservableResult< KinematicType >::m_errStat

protected

Statistical error.

◆ m_errSys

template<typename KinematicType >

ErrorBar<double> PARTONS::ObservableResult< KinematicType >::m_errSys

protected

Systematic error.

◆ m_experimentalDataSetName

template<typename KinematicType >

std::string PARTONS::ObservableResult< KinematicType >::m_experimentalDataSetName

protected

Data set name.

◆ m_value

template<typename KinematicType >

PhysicalType<double> PARTONS::ObservableResult< KinematicType >::m_value

protected

Value of result.

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

include/partons/beans/observable/ObservableResult.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ ~ObservableResult()

◆ ObservableResult() [1/5]

◆ ObservableResult() [2/5]

◆ ObservableResult() [3/5]

◆ ObservableResult() [4/5]

◆ ObservableResult() [5/5]

Member Function Documentation

◆ compare()

◆ getErrScale()

◆ getErrStat()

◆ getErrSys()

◆ getExperimentalDataSetName()

◆ getValue()

◆ setErrScale()

◆ setErrStat()

◆ setErrSys()

◆ setExperimentalDataSetName()

◆ setValue()

◆ toString()

Member Data Documentation

◆ m_errScale

◆ m_errStat

◆ m_errSys

◆ m_experimentalDataSetName

◆ m_value

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