Abstract class for modules evaluating GPD variable xi (DVMP case). More...

Inheritance diagram for PARTONS::DVMPXiConverterModule:

Public Member Functions
	DVMPXiConverterModule (const std::string &className)
	Constructor. More...

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

virtual	~DVMPXiConverterModule ()
	Destructor. More...

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

virtual PhysicalType< double >	compute (const DVMPObservableKinematic &kinematic)=0
	Evaluate scales for a given kinematics. More...

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

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

virtual	~ModuleObject ()
	Default destructor. 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...

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	DVMP_XI_CONVERTER_MODULE_CLASS_NAME
	Type of module name used by the automatization. More...

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

Protected Member Functions
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...

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

	XiConverterModule (const XiConverterModule &other)
	Copy constructor. 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...

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

Detailed Description

Abstract class for modules evaluating GPD variable xi (DVMP case).

Constructor & Destructor Documentation

◆ DVMPXiConverterModule() [1/2]

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

Constructor.

Parameters

className Name of class.

◆ DVMPXiConverterModule() [2/2]

PARTONS::DVMPXiConverterModule::DVMPXiConverterModule ( const DVMPXiConverterModule & other )

Copy constructor.

Parameters

other Object to be copied.

◆ ~DVMPXiConverterModule()

PARTONS::DVMPXiConverterModule::~DVMPXiConverterModule ( )

virtual

Destructor.

Member Function Documentation

◆ clone()

virtual DVMPXiConverterModule* PARTONS::DVMPXiConverterModule::clone ( ) const

pure virtual

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

Returns

Implements PARTONS::XiConverterModule< DVMPObservableKinematic >.

Implemented in PARTONS::DVMPXiConverterXBToXi.

◆ compute()

virtual PhysicalType<double> PARTONS::DVMPXiConverterModule::compute ( const DVMPObservableKinematic & kinematic )

pure virtual

Evaluate scales for a given kinematics.

Implements PARTONS::XiConverterModule< DVMPObservableKinematic >.

Implemented in PARTONS::DVMPXiConverterXBToXi.

◆ initModule()

void PARTONS::DVMPXiConverterModule::initModule ( )

protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::XiConverterModule< DVMPObservableKinematic >.

◆ isModuleWellConfigured()

void PARTONS::DVMPXiConverterModule::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::XiConverterModule< DVMPObservableKinematic >.

Member Data Documentation

◆ DVMP_XI_CONVERTER_MODULE_CLASS_NAME

const std::string PARTONS::DVMPXiConverterModule::DVMP_XI_CONVERTER_MODULE_CLASS_NAME

static

Initial value:

=

"DVMPXiConverterModule"

Type of module name used by the automatization.

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

include/partons/modules/xi_converter/DVMP/DVMPXiConverterModule.h
src/partons/modules/xi_converter/DVMP/DVMPXiConverterModule.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members