PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PARTONS::DDVCSObservable Class Referenceabstract

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

Inheritance diagram for PARTONS::DDVCSObservable:
PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult > PARTONS::ModuleObject PARTONS::BaseObject PARTONS::DDVCSAluPhi PARTONS::DDVCSAluPhiL PARTONS::DDVCSCrossSectionUUMinus PARTONS::DDVCSCrossSectionUUMinusDVCSLimit PARTONS::DDVCSCrossSectionUUMinusTCSLimit PARTONS::DDVCSCrossSectionTotal

Public Member Functions

virtual ~DDVCSObservable ()
 Destructor. More...
 
virtual Observableclone () 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 DDVCSObservableResult compute (const DDVCSObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Computes the observable at given kinematics. More...
 
virtual List< GPDTypegetListOfAvailableGPDTypeForComputation () const
 Must be implemented in child class. More...
 
DDVCSProcessModulegetProcessModule () const
 Get process module. More...
 
void setProcessModule (DDVCSProcessModule *pProcessModule)
 Set process module. More...
 
- Public Member Functions inherited from PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >
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 DDVCS_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

 DDVCSObservable (const std::string &className)
 Default constructor. More...
 
 DDVCSObservable (const DDVCSObservable &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 DDVCSObservableKinematic &kinematic, const List< GPDType > &gpdType)=0
 Evaluate observable. More...
 
- Protected Member Functions inherited from PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >
 Observable (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
 Observable (const Observable &other)
 Copy constructor. More...
 
std::vector< double > serializeKinematicsAndGPDTypesIntoStdVector (const DDVCSObservableKinematic &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, DDVCSObservableKinematic &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

DDVCSProcessModulem_pProcessModule
 Pointer to the underlying process module. More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~DDVCSObservable()

PARTONS::DDVCSObservable::~DDVCSObservable ( )
virtual

Destructor.

◆ DDVCSObservable() [1/2]

PARTONS::DDVCSObservable::DDVCSObservable ( const std::string &  className)
protected

Default constructor.

◆ DDVCSObservable() [2/2]

PARTONS::DDVCSObservable::DDVCSObservable ( const DDVCSObservable other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

virtual Observable* PARTONS::DDVCSObservable::clone ( ) const
pure virtual

◆ compute()

DDVCSObservableResult PARTONS::DDVCSObservable::compute ( const DDVCSObservableKinematic kinematic,
const List< GPDType > &  gpdType = List<GPDType>() 
)
virtual

Computes the observable at given kinematics.

Parameters
kinematicKinematics.
gpdTypeType of GPDs to compute.
Returns
Result.

Implements PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >.

◆ computeObservable()

virtual PhysicalType<double> PARTONS::DDVCSObservable::computeObservable ( const DDVCSObservableKinematic kinematic,
const List< GPDType > &  gpdType 
)
protectedpure virtual

◆ configure()

void PARTONS::DDVCSObservable::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
parametersElemUtils::Parameters object.

Reimplemented from PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >.

Reimplemented in PARTONS::DDVCSCrossSectionTotal.

◆ getListOfAvailableGPDTypeForComputation()

List< GPDType > PARTONS::DDVCSObservable::getListOfAvailableGPDTypeForComputation ( ) const
virtual

Must be implemented in child class.

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

Implements PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >.

◆ getProcessModule()

DDVCSProcessModule * PARTONS::DDVCSObservable::getProcessModule ( ) const

Get process module.

◆ initModule()

void PARTONS::DDVCSObservable::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >.

◆ isModuleWellConfigured()

void PARTONS::DDVCSObservable::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< DDVCSObservableKinematic, DDVCSObservableResult >.

◆ prepareSubModules()

void PARTONS::DDVCSObservable::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
subModulesDataData used to retrieve the needed modules and their configuration.

Reimplemented from PARTONS::Observable< DDVCSObservableKinematic, DDVCSObservableResult >.

◆ resolveObjectDependencies()

void PARTONS::DDVCSObservable::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< DDVCSObservableKinematic, DDVCSObservableResult >.

◆ run()

void PARTONS::DDVCSObservable::run ( )
virtual

◆ setProcessModule()

void PARTONS::DDVCSObservable::setProcessModule ( DDVCSProcessModule pProcessModule)

Set process module.

◆ toString()

std::string PARTONS::DDVCSObservable::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< DDVCSObservableKinematic, DDVCSObservableResult >.

Member Data Documentation

◆ DDVCS_OBSERVABLE_MODULE_CLASS_NAME

const std::string PARTONS::DDVCSObservable::DDVCS_OBSERVABLE_MODULE_CLASS_NAME
static
Initial value:
=
"DDVCSObservableModule"

Type of the module in XML automation.

◆ m_pProcessModule

DDVCSProcessModule* PARTONS::DDVCSObservable::m_pProcessModule
protected

Pointer to the underlying process module.


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