PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Protected Member Functions | List of all members
PARTONS::XiConverterModule< KinematicType > Class Template Referenceabstract

Abstract class for modules evaluating GPD variable xi. More...

Inheritance diagram for PARTONS::XiConverterModule< KinematicType >:
PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

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)
 

Protected Member Functions

 XiConverterModule (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
 XiConverterModule (const XiConverterModule &other)
 Copy constructor. More...
 
virtual XiConverterModuleclone () const =0
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. 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 > compute (const KinematicType &kinematic)=0
 Evaluate scales for a given kinematics. 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

- Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string CLASS_NAME = "className"
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

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

Abstract class for modules evaluating GPD variable xi.

Constructor & Destructor Documentation

◆ ~XiConverterModule()

template<typename KinematicType >
virtual PARTONS::XiConverterModule< KinematicType >::~XiConverterModule ( )
inlinevirtual

Destructor.

◆ XiConverterModule() [1/2]

template<typename KinematicType >
PARTONS::XiConverterModule< KinematicType >::XiConverterModule ( const std::string &  className,
ChannelType::Type  channelType 
)
inlineprotected

Constructor.

Parameters
classNameName of class.

◆ XiConverterModule() [2/2]

template<typename KinematicType >
PARTONS::XiConverterModule< KinematicType >::XiConverterModule ( const XiConverterModule< KinematicType > &  other)
inlineprotected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

template<typename KinematicType >
virtual XiConverterModule* PARTONS::XiConverterModule< KinematicType >::clone ( ) const
protectedpure virtual

◆ compute()

template<typename KinematicType >
virtual PhysicalType<double> PARTONS::XiConverterModule< KinematicType >::compute ( const KinematicType kinematic)
protectedpure virtual

◆ initModule()

template<typename KinematicType >
virtual void PARTONS::XiConverterModule< KinematicType >::initModule ( )
inlineprotectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Implements PARTONS::ModuleObject.

Reimplemented in PARTONS::TCSXiConverterModule, PARTONS::GAM2XiConverterModule, PARTONS::DVMPXiConverterModule, PARTONS::DVCSXiConverterModule, and PARTONS::DDVCSXiConverterModule.

◆ isModuleWellConfigured()

template<typename KinematicType >
virtual void PARTONS::XiConverterModule< KinematicType >::isModuleWellConfigured ( )
inlineprotectedvirtual

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

Children must define and override it.

Implements PARTONS::ModuleObject.

Reimplemented in PARTONS::TCSXiConverterModule, PARTONS::GAM2XiConverterModule, PARTONS::DVMPXiConverterModule, PARTONS::DVCSXiConverterModule, and PARTONS::DDVCSXiConverterModule.


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