PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Private Attributes | List of all members
PARTONS::ResultInfo Class Reference

Class storing information associated to result evaluation. More...

Inheritance diagram for PARTONS::ResultInfo:
PARTONS::BaseObject

Public Member Functions

 ResultInfo ()
 Default constructor. More...
 
 ResultInfo (const ResultInfo &other)
 Copy constructor. More...
 
virtual ~ResultInfo ()
 Destructor. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. More...
 
const ComputationgetComputation () const
 Get computation information associated to the corresponding result. More...
 
void setComputation (const Computation &computation)
 Set computation information associated to the corresponding result. More...
 
const std::string & getScenarioHashSum () const
 Get hash sum of scenario associated to the corresponding result. More...
 
void setScenarioHashSum (const std::string &scenarioHashSum)
 Set hash sum of scenario associated to the corresponding result. More...
 
const std::string & getEnvironmentConfigurationHashSum () const
 Get hash sum of environment configuration associated to the corresponding result. More...
 
void setEnvironmentConfigurationHashSum (const std::string &environmentConfigurationHashSum)
 Set hash sum of environment configuration associated to the corresponding result. More...
 
unsigned int getScenarioTaskIndexNumber () const
 Get id of task used to evaluate the corresponding result. More...
 
void setScenarioTaskIndexNumber (unsigned int scenarioTaskIndexNumber)
 Set id of task used to evaluate the corresponding result. 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 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...
 
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)
 

Private Attributes

Computation m_computation
 Computation information associated to the corresponding result. More...
 
std::string m_scenarioHashSum
 Hash sum of scenario associated to the corresponding result. More...
 
std::string m_environmentConfigurationHashSum
 Hash sum of environment configuration associated to the corresponding result. More...
 
unsigned int m_scenarioTaskIndexNumber
 Id of task used to evaluate the corresponding result. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Class storing information associated to result evaluation.

This class is used to store an information associated to the evaluation of a single result, like the hash sum of used scenario or id of used task.

Constructor & Destructor Documentation

◆ ResultInfo() [1/2]

PARTONS::ResultInfo::ResultInfo ( )

Default constructor.

◆ ResultInfo() [2/2]

PARTONS::ResultInfo::ResultInfo ( const ResultInfo other)

Copy constructor.

Parameters
otherObject to be copied.

◆ ~ResultInfo()

PARTONS::ResultInfo::~ResultInfo ( )
virtual

Destructor.

Member Function Documentation

◆ getComputation()

const Computation & PARTONS::ResultInfo::getComputation ( ) const

Get computation information associated to the corresponding result.

◆ getEnvironmentConfigurationHashSum()

const std::string & PARTONS::ResultInfo::getEnvironmentConfigurationHashSum ( ) const

Get hash sum of environment configuration associated to the corresponding result.

◆ getScenarioHashSum()

const std::string & PARTONS::ResultInfo::getScenarioHashSum ( ) const

Get hash sum of scenario associated to the corresponding result.

◆ getScenarioTaskIndexNumber()

unsigned int PARTONS::ResultInfo::getScenarioTaskIndexNumber ( ) const

Get id of task used to evaluate the corresponding result.

◆ setComputation()

void PARTONS::ResultInfo::setComputation ( const Computation computation)

Set computation information associated to the corresponding result.

◆ setEnvironmentConfigurationHashSum()

void PARTONS::ResultInfo::setEnvironmentConfigurationHashSum ( const std::string &  environmentConfigurationHashSum)

Set hash sum of environment configuration associated to the corresponding result.

◆ setScenarioHashSum()

void PARTONS::ResultInfo::setScenarioHashSum ( const std::string &  scenarioHashSum)

Set hash sum of scenario associated to the corresponding result.

◆ setScenarioTaskIndexNumber()

void PARTONS::ResultInfo::setScenarioTaskIndexNumber ( unsigned int  scenarioTaskIndexNumber)

Set id of task used to evaluate the corresponding result.

◆ toString()

std::string PARTONS::ResultInfo::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::BaseObject.

Member Data Documentation

◆ m_computation

Computation PARTONS::ResultInfo::m_computation
private

Computation information associated to the corresponding result.

◆ m_environmentConfigurationHashSum

std::string PARTONS::ResultInfo::m_environmentConfigurationHashSum
private

Hash sum of environment configuration associated to the corresponding result.

◆ m_scenarioHashSum

std::string PARTONS::ResultInfo::m_scenarioHashSum
private

Hash sum of scenario associated to the corresponding result.

◆ m_scenarioTaskIndexNumber

unsigned int PARTONS::ResultInfo::m_scenarioTaskIndexNumber
private

Id of task used to evaluate the corresponding result.


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