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

Class representing single result of TCS observable computation. More...

Inheritance diagram for PARTONS::TCSObservableResult:
PARTONS::ObservableResult< TCSObservableKinematic > PARTONS::Result< KinematicType > PARTONS::BaseObject

Public Member Functions

 TCSObservableResult ()
 Default constructor. More...
 
 TCSObservableResult (const PhysicalType< double > &value)
 Assignment constructor. More...
 
 TCSObservableResult (const TCSObservableKinematic &kinematic)
 Assignment constructor. More...
 
 TCSObservableResult (const PhysicalType< double > &value, const TCSObservableKinematic &kinematic)
 Assignment constructor. More...
 
 TCSObservableResult (const TCSObservableResult &other)
 Copy constructor. More...
 
virtual ~TCSObservableResult ()
 Destructor. More...
 
- Public Member Functions inherited from PARTONS::ObservableResult< TCSObservableKinematic >
virtual ~ObservableResult ()
 Destructor. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. More...
 
void compare (ComparisonReport &rootComparisonReport, const ObservableResult &referenceObject, std::string parentObjectInfo=ElemUtils::StringUtils::EMPTY) const
 Compare to other DVCSConvolCoeffFunctionResult object and store comparison result in given comparison report. More...
 
const PhysicalType< double > & getValue () const
 Get value of result. More...
 
void setValue (const PhysicalType< double > &value)
 Set value of result. More...
 
const ErrorBar< double > & getErrStat () const
 Get statistical uncertainty. More...
 
void setErrStat (const ErrorBar< double > &errStat)
 Set statistical uncertainty. More...
 
const ErrorBar< double > & getErrSys () const
 Get systematic uncertainty. More...
 
void setErrSys (const ErrorBar< double > &errSys)
 Set systematic uncertainty. More...
 
const ErrorBar< double > & getErrScale () const
 Get scale uncertainty. More...
 
void setErrScale (const ErrorBar< double > &errScale)
 Set scale uncertainty. More...
 
const std::string & getExperimentalDataSetName () const
 Get data set name. More...
 
void setExperimentalDataSetName (const std::string &experimentalDataSetName)
 Set data set name. More...
 
- Public Member Functions inherited from PARTONS::Result< KinematicType >
virtual ~Result ()
 Destructor. More...
 
bool operator< (const Result< KinematicType > &other) const
 Relation operator that checks if the value of left operand is less than the value of right operand (in this case returned is this->m_kinematic < other.m_kinematic). More...
 
ChannelType::Type getChannelType () const
 Get channel type. More...
 
void setComputationModuleName (const std::string &moduleName)
 Set name of module used to evaluate this result. More...
 
const std::string & getComputationModuleName () const
 Get name of module used to evaluate this result. More...
 
void setResultInfo (const ResultInfo &resultInfo)
 Set information on this result. More...
 
const ResultInfogetResultInfo () const
 Get information on this result. More...
 
void setKinematic (const KinematicType &kinematic)
 Set kinematics associated to this result. More...
 
const KinematicTypegetKinematic () const
 Get reference to kinematics associated to this 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)
 

Additional Inherited Members

- Protected Member Functions inherited from PARTONS::ObservableResult< TCSObservableKinematic >
 ObservableResult (const std::string &className, ChannelType::Type channelType)
 Default constructor. More...
 
 ObservableResult (const std::string &className, ChannelType::Type channelType, const PhysicalType< double > &value)
 Assignment constructor. More...
 
 ObservableResult (const std::string &className, ChannelType::Type channelType, const TCSObservableKinematic &kinematic)
 Assignment constructor. More...
 
 ObservableResult (const std::string &className, ChannelType::Type channelType, const PhysicalType< double > &value, const TCSObservableKinematic &kinematic)
 Assignment constructor. More...
 
 ObservableResult (const ObservableResult &other)
 Copy constructor. More...
 
- Protected Member Functions inherited from PARTONS::Result< KinematicType >
 Result (const std::string &className, ChannelType::Type channelType)
 Default constructor. More...
 
 Result (const std::string &className, ChannelType::Type channelType, const KinematicType &kinematic)
 Assignment constructor. More...
 
 Result (const Result &other)
 Copy constructor. 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...
 
- Protected Attributes inherited from PARTONS::ObservableResult< TCSObservableKinematic >
PhysicalType< double > m_value
 Value of result. More...
 
ErrorBar< double > m_errStat
 Statistical error. More...
 
ErrorBar< double > m_errSys
 Systematic error. More...
 
ErrorBar< double > m_errScale
 Systematic error. More...
 
std::string m_experimentalDataSetName
 Data set name. More...
 
- Protected Attributes inherited from PARTONS::Result< KinematicType >
ChannelType::Type m_channelType
 Channel type. More...
 
std::string m_computationModuleName
 Name of module used to evaluate this result. More...
 
ResultInfo m_resultInfo
 Information on this result. More...
 
KinematicType m_kinematic
 Kinematics associated to this result. More...
 

Detailed Description

Class representing single result of TCS observable computation.

This class is used to store a result of a single TCS observable computation.

Constructor & Destructor Documentation

◆ TCSObservableResult() [1/5]

PARTONS::TCSObservableResult::TCSObservableResult ( )

Default constructor.

◆ TCSObservableResult() [2/5]

PARTONS::TCSObservableResult::TCSObservableResult ( const PhysicalType< double > &  value)

Assignment constructor.

Parameters
valueValue to be assigned.

◆ TCSObservableResult() [3/5]

PARTONS::TCSObservableResult::TCSObservableResult ( const TCSObservableKinematic kinematic)

Assignment constructor.

Parameters
kinematicTCS observable kinematic to be assigned.

◆ TCSObservableResult() [4/5]

PARTONS::TCSObservableResult::TCSObservableResult ( const PhysicalType< double > &  value,
const TCSObservableKinematic kinematic 
)

Assignment constructor.

Parameters
valueValue to be assigned.
kinematicTCS observable kinematic to be assigned.

◆ TCSObservableResult() [5/5]

PARTONS::TCSObservableResult::TCSObservableResult ( const TCSObservableResult other)

Copy constructor.

Parameters
otherObject to be copied.

◆ ~TCSObservableResult()

PARTONS::TCSObservableResult::~TCSObservableResult ( )
virtual

Destructor.


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