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

Singleton to handle and compute some pre-configured CCF modules. More...

Inheritance diagram for PARTONS::TCSConvolCoeffFunctionService:
PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult > PARTONS::ServiceObjectTyped< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult > PARTONS::ServiceObject PARTONS::BaseObject

Public Member Functions

virtual ~TCSConvolCoeffFunctionService ()
 Destructor. 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 TCSConvolCoeffFunctionKinematic newKinematicFromTask (const Task &task) const
 Uses an automation task (XML file) to set specific kinematics. More...
 
virtual List< TCSConvolCoeffFunctionKinematicnewListOfKinematicFromTask (const Task &task) const
 Uses an automation task (XML file) to set a list of kinematics. More...
 
virtual void storeResultListInDatabase (const List< TCSConvolCoeffFunctionResult > &results) const
 Store list of results in DB. More...
 
virtual void generatePlotFileTask (Task &task)
 Method used in the automated interface to generate a data file ready for plotting. More...
 
TCSConvolCoeffFunctionModulenewTCSConvolCoeffFunctionModuleFromTask (const Task &task) const
 Uses an automation task (XML file) to configure a TCSConvolCoeffFunctionModule. More...
 
- Public Member Functions inherited from PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
virtual ~ConvolCoeffFunctionService ()
 Destructor. More...
 
virtual void computeTask (Task &task)
 Compute task. More...
 
TCSConvolCoeffFunctionResult computeSingleKinematic (const TCSConvolCoeffFunctionKinematic &kinematic, ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult > *pConvolCoeffFunctionModule, const List< GPDType > &gpdTypeList=List< GPDType >()) const
 Computes a ConvolCoeffFunctionModule at specific kinematics. More...
 
List< TCSConvolCoeffFunctionResultcomputeManyKinematic (List< TCSConvolCoeffFunctionKinematic > &kinematics, ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult > *pConvolCoeffFunctionModule, const List< GPDType > &gpdTypeList=List< GPDType >())
 Computes a CCF Model for a list of kinematics. More...
 
- Public Member Functions inherited from PARTONS::ServiceObjectTyped< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
virtual ~ServiceObjectTyped ()
 Destructor. More...
 
void add (const TCSConvolCoeffFunctionResult &result)
 Add single result to result list. More...
 
void add (const List< TCSConvolCoeffFunctionResult > &resultList)
 Add many results to result list. More...
 
void sortResultList ()
 Sort result list. More...
 
List< TCSConvolCoeffFunctionResult > & getResultList ()
 Get result list. More...
 
void clearResultListBuffer ()
 Clear result list. More...
 
void clearKinematicListBuffer ()
 Clear kinematic list. More...
 
List< TCSConvolCoeffFunctionResultcomputeScenario (Scenario &scenario)
 Compute scenario. More...
 
List< TCSConvolCoeffFunctionResultflushResultList ()
 Flush result list. More...
 
- Public Member Functions inherited from PARTONS::ServiceObject
 ServiceObject (const std::string &className)
 Default constructor. More...
 
virtual ~ServiceObject ()
 Default destructor. More...
 
void addTasks (const List< ElemUtils::Packet > &tasks)
 Add task to queue. More...
 
bool isEmptyTaskQueue ()
 Check if queue is empty. More...
 
ElemUtils::Packet popTaskFormQueue ()
 Pop task from queue. More...
 
void initComputationalThread (ModuleObject *pModuleObject)
 Initialize all threads. More...
 
void launchAllThreadAndWaitingFor ()
 Lunch all threads. More...
 
void clearAllThread ()
 Clear all threads. More...
 
std::string generateSQLQueryForPlotFile (const std::string &tableName, const ElemUtils::Parameters &selectParams, const ElemUtils::Parameters &whereParams) const
 Generate SQL query to create a plot file. More...
 
void generatePlotFile (const std::string &filePath, const std::string &sqlQuery, const char splitChar) const
 Generate a plot file. More...
 
- Public Member Functions inherited from PARTONS::BaseObject
 BaseObject (const std::string &className)
 Constructor. More...
 
virtual ~BaseObject ()
 Default destructor. More...
 
virtual BaseObjectclone () const
 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...
 
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::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
static const std::string CCF_SERVICE_COMPUTE_SINGLE_KINEMATIC
 Name of the XML task used for computing a CCF. More...
 
static const std::string CCF_SERVICE_COMPUTE_MANY_KINEMATIC
 Name of the XML task used for computing CCFs with a list of kinematics. More...
 
static const std::string CCF_SERVICE_GENERATE_PLOT_FILE
 Name of the XML task used for generating a data file ready for plotting. More...
 
- Static Public Attributes inherited from PARTONS::ServiceObjectTyped< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
static const std::string SERVICE_OBJECT_PRINT_RESULTS
 Name of the XML task used to print results via Logger. More...
 

Protected Member Functions

 TCSConvolCoeffFunctionService (const std::string &className)
 Default constructor. More...
 
virtual ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult > * newConvolCoeffFunctionModuleFromTask (const Task &task) const
 Uses an automation task (XML file) to configure a ConvolCoeffFunctionModule. More...
 
- Protected Member Functions inherited from PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
 ConvolCoeffFunctionService (const std::string &className)
 Default constructor. More...
 
- Protected Member Functions inherited from PARTONS::ServiceObjectTyped< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
 ServiceObjectTyped (const std::string &className)
 Default constructor. More...
 
bool computeGeneralTask (Task &task)
 General tasks. More...
 
void printResultListBuffer ()
 Print results to buffer. More...
 
void updateResultInfo (TCSConvolCoeffFunctionResult &result, const ResultInfo &resultInfo)
 Update result info. More...
 
void updateResultInfo (List< TCSConvolCoeffFunctionResult > &resultList, const ResultInfo &resultInfo)
 Update result info. More...
 
- Protected Member Functions inherited from PARTONS::ServiceObject
std::string generateSQLQueryForPlotFileTask (Task &task, const std::string &tableName) const
 Generate SQL query from a task. More...
 
std::string getOutputFilePathForPlotFileTask (Task &task) const
 Get path to a plot file from a task. More...
 
List< GPDTypegetGPDTypeListFromTask (Task &task) const
 Get list of GPD types to be computed from a task. More...
 
void errorUnknownMethod (const Task &task) const
 Throw exception if unknown method. More...
 
- 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::ServiceObjectTyped< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
unsigned int m_batchSize
 Batch size. More...
 
sf::Mutex m_mutexKinematicList
 Mutex for kinematic list. More...
 
sf::Mutex m_mutexResultListBuffer
 Mutex for result list. More...
 
List< TCSConvolCoeffFunctionKinematicm_kinematicListBuffer
 Kinematic list. More...
 
List< TCSConvolCoeffFunctionResultm_resultListBuffer
 Result list. More...
 
ResultInfo m_resultInfo
 Result info. More...
 
- Protected Attributes inherited from PARTONS::ServiceObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer to ModuleObjectFactory. More...
 
AutomationServicem_pAutomationService
 Pointer to AutomationService. More...
 

Detailed Description

Singleton to handle and compute some pre-configured CCF modules.

See the general tutorial and this table of examples.

Constructor & Destructor Documentation

◆ ~TCSConvolCoeffFunctionService()

PARTONS::TCSConvolCoeffFunctionService::~TCSConvolCoeffFunctionService ( )
virtual

Destructor.

◆ TCSConvolCoeffFunctionService()

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

Default constructor.

Member Function Documentation

◆ generatePlotFileTask()

void PARTONS::TCSConvolCoeffFunctionService::generatePlotFileTask ( Task task)
virtual

Method used in the automated interface to generate a data file ready for plotting.

Parameters
taskAutomated XML task.

Implements PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >.

◆ newConvolCoeffFunctionModuleFromTask()

ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult > * PARTONS::TCSConvolCoeffFunctionService::newConvolCoeffFunctionModuleFromTask ( const Task task) const
protectedvirtual

Uses an automation task (XML file) to configure a ConvolCoeffFunctionModule.

Parameters
taskAutomation task.
Returns
Pre-configured ConvolCoeffFunctionModule.

Implements PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >.

◆ newKinematicFromTask()

TCSConvolCoeffFunctionKinematic PARTONS::TCSConvolCoeffFunctionService::newKinematicFromTask ( const Task task) const
virtual

Uses an automation task (XML file) to set specific kinematics.

Parameters
taskTask.
Returns
CCF kinematics.

Implements PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >.

◆ newListOfKinematicFromTask()

List< TCSConvolCoeffFunctionKinematic > PARTONS::TCSConvolCoeffFunctionService::newListOfKinematicFromTask ( const Task task) const
virtual

Uses an automation task (XML file) to set a list of kinematics.

Parameters
taskTask.
Returns
List of CCF kinematics.

Implements PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >.

◆ newTCSConvolCoeffFunctionModuleFromTask()

TCSConvolCoeffFunctionModule * PARTONS::TCSConvolCoeffFunctionService::newTCSConvolCoeffFunctionModuleFromTask ( const Task task) const

Uses an automation task (XML file) to configure a TCSConvolCoeffFunctionModule.

Parameters
taskAutomation task.
Returns
Pre-configured TCSConvolCoeffFunctionModule.

◆ resolveObjectDependencies()

void PARTONS::TCSConvolCoeffFunctionService::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::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >.

◆ storeResultListInDatabase()

void PARTONS::TCSConvolCoeffFunctionService::storeResultListInDatabase ( const List< TCSConvolCoeffFunctionResult > &  results) const
virtual

Store list of results in DB.

Parameters
resultsList of results.
Returns
True is insertion successful.

Implements PARTONS::ConvolCoeffFunctionService< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >.

Member Data Documentation

◆ classId

const unsigned int PARTONS::TCSConvolCoeffFunctionService::classId
static
Initial value:

Unique ID to automatically register the class in the registry.


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