PARTONS::GPDSubtractionConstantResult Class Reference

Class representing single result of GPD subtraction constant computation. More...

Inheritance diagram for PARTONS::GPDSubtractionConstantResult:

Public Member Functions
	GPDSubtractionConstantResult ()
	Default constructor. More...
	GPDSubtractionConstantResult (const PhysicalType< double > &value)
	Assignment constructor. More...
	GPDSubtractionConstantResult (const GPDSubtractionConstantKinematic &kinematic)
	Assignment constructor. More...
	GPDSubtractionConstantResult (const PhysicalType< double > &value, const GPDSubtractionConstantKinematic &kinematic)
	Assignment constructor. More...
	GPDSubtractionConstantResult (const GPDSubtractionConstantResult &other)
	Copy constructor. More...
virtual	~GPDSubtractionConstantResult ()
	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 GPDSubtractionConstantResult &referenceObject, std::string parentObjectInfo="") const
	Compare to other GPDSubtractionConstantResult 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...
Public Member Functions inherited from PARTONS::Result< GPDSubtractionConstantKinematic >
virtual	~Result ()
	Destructor. More...
bool	operator< (const Result< GPDSubtractionConstantKinematic > &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 GPDSubtractionConstantKinematic &kinematic)
	Set kinematics associated to this result. More...
const GPDSubtractionConstantKinematic &	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
PhysicalType< double >	m_value
	Result of computation. More...

Additional Inherited Members
Protected Member Functions inherited from PARTONS::Result< GPDSubtractionConstantKinematic >
	Result (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...
	Result (const std::string &className, ChannelType::Type channelType, const GPDSubtractionConstantKinematic &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< GPDSubtractionConstantKinematic >
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...
GPDSubtractionConstantKinematic	m_kinematic
	Kinematics associated to this result. More...

Detailed Description

Class representing single result of GPD subtraction constant computation.

This class is used to store results of a single GPD subtraction constant computation.

Constructor & Destructor Documentation

GPDSubtractionConstantResult() [1/5]

PARTONS::GPDSubtractionConstantResult::GPDSubtractionConstantResult

(

)

Default constructor.

GPDSubtractionConstantResult() [2/5]

PARTONS::GPDSubtractionConstantResult::GPDSubtractionConstantResult

(

const PhysicalType< double > &

value

)

Assignment constructor.

Parameters

value

Value to be assigned.

GPDSubtractionConstantResult() [3/5]

PARTONS::GPDSubtractionConstantResult::GPDSubtractionConstantResult

(

const GPDSubtractionConstantKinematic &

kinematic

)

Assignment constructor.

Parameters

kinematic

GPD kinematics to be assigned.

GPDSubtractionConstantResult() [4/5]

PARTONS::GPDSubtractionConstantResult::GPDSubtractionConstantResult	(	const PhysicalType< double > &	value,
		const GPDSubtractionConstantKinematic &	kinematic
	)

Assignment constructor.

Parameters

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

GPDSubtractionConstantResult() [5/5]

PARTONS::GPDSubtractionConstantResult::GPDSubtractionConstantResult

(

const GPDSubtractionConstantResult &

other

)

Copy constructor.

Parameters

other

Object to be copied.

~GPDSubtractionConstantResult()

PARTONS::GPDSubtractionConstantResult::~GPDSubtractionConstantResult ( )

virtual

Destructor.

Member Function Documentation

compare()

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

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

getValue()

const PhysicalType< double > & PARTONS::GPDSubtractionConstantResult::getValue

(

)

const

Get value of result.

setValue()

void PARTONS::GPDSubtractionConstantResult::setValue

(

const PhysicalType< double > &

value

)

Set value of result.

toString()

std::string PARTONS::GPDSubtractionConstantResult::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< GPDSubtractionConstantKinematic >.

Member Data Documentation

m_value

PhysicalType<double> PARTONS::GPDSubtractionConstantResult::m_value

private

Result of computation.

---

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

• include/partons/beans/gpd/GPDSubtractionConstantResult.h
• src/partons/beans/gpd/GPDSubtractionConstantResult.cpp