Abstract class that provides a skeleton to implement a TCSObservable module. More...

Inheritance diagram for PARTONS::TCSObservable:

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

virtual Observable *	clone () const =0
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...

virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. 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...

virtual void	run ()

virtual void	configure (const ElemUtils::Parameters &parameters)
	Provides a generic method to configure all types of modules by passing a Parameters object. More...

virtual void	prepareSubModules (const std::map< std::string, BaseObjectData > &subModulesData)
	Method used in automation to prepare all the modules used by this current module and configure them recursively. More...

virtual TCSObservableResult	compute (const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
	Computes the observable at given kinematics. More...

virtual List< GPDType >	getListOfAvailableGPDTypeForComputation () const
	Must be implemented in child class. More...

TCSProcessModule *	getProcessModule () const
	Get process module. More...

void	setProcessModule (TCSProcessModule *pProcessModule)
	Set process module. More...

Public Member Functions inherited from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >
virtual	~Observable ()
	Destructor. More...

Public Member Functions inherited from PARTONS::ModuleObject
	ModuleObject (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

virtual	~ModuleObject ()
	Default destructor. More...

unsigned int	getReferenceModuleId () const
	Get reference module id. More...

void	setReferenceModuleId (unsigned int referenceModuleId)
	Set reference module id. More...

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

Public Member Functions inherited from PARTONS::BaseObject
	BaseObject (const std::string &className)
	Constructor. More...

virtual	~BaseObject ()
	Default destructor. 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	TCS_OBSERVABLE_MODULE_CLASS_NAME
	Type of the module in XML automation. More...

Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string	CLASS_NAME = "className"

Protected Member Functions
	TCSObservable (const std::string &className)
	Default constructor. More...

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

virtual void	initModule ()
	Pure virtual function that provides skeleton for module initialization. More...

virtual void	isModuleWellConfigured ()
	Pure virtual function that provides skeleton to check if the module is well initialized and configured. More...

virtual PhysicalType< double >	computeObservable (const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType)=0
	Evaluate observable. More...

Protected Member Functions inherited from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >
	Observable (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

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

std::vector< double >	serializeKinematicsAndGPDTypesIntoStdVector (const TCSObservableKinematic &kin, const List< GPDType > &list) const
	Serialize kinematics and list of GPD types to std::vector<double>. More...

void	unserializeKinematicsAndGPDTypesFromStdVector (const std::vector< double > &vec, TCSObservableKinematic &kin, List< GPDType > &list) const
	Unserialize kinematics and list of GPD types from std::vector<double>. More...

Protected Member Functions inherited from PARTONS::ModuleObject
	ModuleObject (const ModuleObject &other)

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
TCSProcessModule *	m_pProcessModule
	Pointer to the underlying process module. More...

Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactory *	m_pModuleObjectFactory
	Pointer tp module object factory. More...

Detailed Description

Abstract class that provides a skeleton to implement a TCSObservable module.

Constructor & Destructor Documentation

◆ ~TCSObservable()

PARTONS::TCSObservable::~TCSObservable ( )

virtual

Destructor.

◆ TCSObservable() [1/2]

PARTONS::TCSObservable::TCSObservable ( const std::string & className )

protected

Default constructor.

◆ TCSObservable() [2/2]

PARTONS::TCSObservable::TCSObservable ( const TCSObservable & other )

protected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ clone()

virtual Observable* PARTONS::TCSObservable::clone ( ) const

pure virtual

Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry.

Returns

Implements PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ compute()

TCSObservableResult PARTONS::TCSObservable::compute	(	const TCSObservableKinematic &	kinematic,
		const List< GPDType > &	gpdType = `List<GPDType>()`
	)

virtual

Computes the observable at given kinematics.

Parameters

kinematic	Kinematics.
gpdType	Type of GPDs to compute.

Returns: Result.

Implements PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ computeObservable()

virtual PhysicalType<double> PARTONS::TCSObservable::computeObservable	(	const TCSObservableKinematic &	kinematic,
		const List< GPDType > &	gpdType
	)

protectedpure virtual

Evaluate observable.

To be implemented in a child class.

Implements PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ configure()

void PARTONS::TCSObservable::configure ( const ElemUtils::Parameters & parameters )

virtual

Provides a generic method to configure all types of modules by passing a Parameters object.

Parameters class represents a list of couples key/value (see Parameters class documentation for more info).

Parameters

parameters ElemUtils::Parameters object.

Reimplemented from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

Reimplemented in PARTONS::TCSCrossSectionUUWeightedThetaIntegrated, PARTONS::TCSCrossSectionUUThetaIntegrated, PARTONS::TCSCrossSectionTotal, PARTONS::TCSCrossSectionDifferenceCUThetaIntegrated, PARTONS::TCSAutSinPhiMPhisThetaIntegrated, PARTONS::TCSAutCosPhiMPhisThetaIntegrated, and PARTONS::TCSAcuThetaIntegrated.

◆ getListOfAvailableGPDTypeForComputation()

List< GPDType > PARTONS::TCSObservable::getListOfAvailableGPDTypeForComputation ( ) const

virtual

Must be implemented in child class.

Returns: List of GPD/CCF types the child class can compute.

Implements PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ getProcessModule()

TCSProcessModule * PARTONS::TCSObservable::getProcessModule ( ) const

Get process module.

◆ initModule()

void PARTONS::TCSObservable::initModule ( )

protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ isModuleWellConfigured()

void PARTONS::TCSObservable::isModuleWellConfigured ( )

protectedvirtual

Pure virtual function that provides skeleton to check if the module is well initialized and configured.

Children must define and override it.

Reimplemented from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ prepareSubModules()

void PARTONS::TCSObservable::prepareSubModules ( const std::map< std::string, BaseObjectData > & subModulesData )

virtual

Method used in automation to prepare all the modules used by this current module and configure them recursively.

The recursion is linked to the imbrication in XML files.
Can be implemented in the child class if it needs modules not needed by the parent class. But there must be first a call to the parent method.

Parameters

subModulesData Data used to retrieve the needed modules and their configuration.

Reimplemented from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ resolveObjectDependencies()

void PARTONS::TCSObservable::resolveObjectDependencies ( )

virtual

Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others.

To avoid the problem of pointer resolution order, this method is called by the BaseObjectRegistery after all objects are well registered in it. See BaseObjectRegistry class documentation for more details.

Reimplemented from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ run()

void PARTONS::TCSObservable::run ( )

virtual

Reimplemented from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >.

◆ setProcessModule()

void PARTONS::TCSObservable::setProcessModule ( TCSProcessModule * pProcessModule )

Set process module.

◆ toString()

std::string PARTONS::TCSObservable::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::Observable< TCSObservableKinematic, TCSObservableResult >.

Member Data Documentation

◆ m_pProcessModule

TCSProcessModule* PARTONS::TCSObservable::m_pProcessModule

protected

Pointer to the underlying process module.

◆ TCS_OBSERVABLE_MODULE_CLASS_NAME

const std::string PARTONS::TCSObservable::TCS_OBSERVABLE_MODULE_CLASS_NAME

static

Initial value:

=

"TCSObservableModule"

Type of the module in XML automation.

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

include/partons/modules/observable/TCS/TCSObservable.h
src/partons/modules/observable/TCS/TCSObservable.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~TCSObservable()

◆ TCSObservable() [1/2]

◆ TCSObservable() [2/2]

Member Function Documentation

◆ clone()

◆ compute()

◆ computeObservable()

◆ configure()

◆ getListOfAvailableGPDTypeForComputation()

◆ getProcessModule()

◆ initModule()

◆ isModuleWellConfigured()

◆ prepareSubModules()

◆ resolveObjectDependencies()

◆ run()

◆ setProcessModule()

◆ toString()

Member Data Documentation

◆ m_pProcessModule

◆ TCS_OBSERVABLE_MODULE_CLASS_NAME