PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Static Public Attributes | List of all members
PARTONS::DDVCSScalesVirtualitiesSum Class Reference
Inheritance diagram for PARTONS::DDVCSScalesVirtualitiesSum:
PARTONS::DDVCSScalesModule PARTONS::ScalesModule< DDVCSObservableKinematic > PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 DDVCSScalesVirtualitiesSum (const std::string &className)
 Constructor. More...
 
 DDVCSScalesVirtualitiesSum (const DDVCSScalesVirtualitiesSum &other)
 Copy constructor. More...
 
virtual ~DDVCSScalesVirtualitiesSum ()
 Destructor. More...
 
virtual DDVCSScalesVirtualitiesSumclone () const
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
 
virtual Scales compute (const DDVCSObservableKinematic &kinematic)
 Evaluate scales for a given kinematics. More...
 
- Public Member Functions inherited from PARTONS::DDVCSScalesModule
 DDVCSScalesModule (const std::string &className)
 Constructor. More...
 
 DDVCSScalesModule (const DDVCSScalesModule &other)
 Copy constructor. More...
 
virtual ~DDVCSScalesModule ()
 Destructor. More...
 
- Public Member Functions inherited from PARTONS::ScalesModule< DDVCSObservableKinematic >
virtual ~ScalesModule ()
 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 unsigned int classId
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::DDVCSScalesModule
static const std::string DDVCS_SCALES_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"
 

Additional Inherited Members

- Protected Member Functions inherited from PARTONS::DDVCSScalesModule
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::ScalesModule< DDVCSObservableKinematic >
 ScalesModule (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
 ScalesModule (const ScalesModule &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...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Constructor & Destructor Documentation

◆ DDVCSScalesVirtualitiesSum() [1/2]

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

Constructor.

Parameters
classNameName of class.

◆ DDVCSScalesVirtualitiesSum() [2/2]

PARTONS::DDVCSScalesVirtualitiesSum::DDVCSScalesVirtualitiesSum ( const DDVCSScalesVirtualitiesSum other)

Copy constructor.

Parameters
otherObject to be copied.

◆ ~DDVCSScalesVirtualitiesSum()

PARTONS::DDVCSScalesVirtualitiesSum::~DDVCSScalesVirtualitiesSum ( )
virtual

Destructor.

Member Function Documentation

◆ clone()

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

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

Returns

Implements PARTONS::DDVCSScalesModule.

◆ compute()

Scales PARTONS::DDVCSScalesVirtualitiesSum::compute ( const DDVCSObservableKinematic kinematic)
virtual

Evaluate scales for a given kinematics.

Implements PARTONS::DDVCSScalesModule.

Member Data Documentation

◆ classId

const unsigned int PARTONS::DDVCSScalesVirtualitiesSum::classId
static
Initial value:
=
new DDVCSScalesVirtualitiesSum("DDVCSScalesVirtualitiesSum"))
unsigned int registerBaseObject(BaseObject *pBaseObject)
Store a unique instance of a module identified by a unique string character key.
Definition: BaseObjectRegistry.cpp:45
static BaseObjectRegistry * getInstance()
Static function to be able to retrieve a unique instance pointer of this class anywhere in the code.
Definition: BaseObjectRegistry.cpp:15
DDVCSScalesVirtualitiesSum(const std::string &className)
Constructor.
Definition: DDVCSScalesVirtualitiesSum.cpp:14

Unique ID to automatically register the class in the registry.


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