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

Base class for all result-like classes. More...

Inheritance diagram for PARTONS::Result< KinematicType >:
PARTONS::BaseObject PARTONS::ConvolCoeffFunctionResult< TCSConvolCoeffFunctionKinematic > PARTONS::ConvolCoeffFunctionResult< DVMPConvolCoeffFunctionKinematic > PARTONS::ConvolCoeffFunctionResult< DDVCSConvolCoeffFunctionKinematic > PARTONS::ConvolCoeffFunctionResult< DVCSConvolCoeffFunctionKinematic > PARTONS::ConvolCoeffFunctionResult< GAM2ConvolCoeffFunctionKinematic > PARTONS::ObservableResult< DVMPObservableKinematic > PARTONS::ObservableResult< DVCSObservableKinematic > PARTONS::ObservableResult< GAM2ObservableKinematic > PARTONS::ObservableResult< TCSObservableKinematic > PARTONS::ObservableResult< DDVCSObservableKinematic > PARTONS::ConvolCoeffFunctionResult< KinematicType > PARTONS::ObservableResult< KinematicType >

Public Member Functions

virtual ~Result ()
 Destructor. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. 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)
 

Protected Member Functions

 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

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

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

Base class for all result-like classes.

This class is used as a base (abstract) class for all classes storing result information, like e.g. GPDResult or ObservableResult.

Constructor & Destructor Documentation

◆ ~Result()

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

Destructor.

◆ Result() [1/3]

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

Default constructor.

Parameters
classNameName of class to be associated to BaseObject (see BaseObject::m_className variable).
channelTypeChannel type.

◆ Result() [2/3]

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

Assignment constructor.

Parameters
kinematicKinematics to be assigned.

◆ Result() [3/3]

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

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ getChannelType()

template<typename KinematicType >
ChannelType::Type PARTONS::Result< KinematicType >::getChannelType ( ) const
inline

Get channel type.

◆ getComputationModuleName()

template<typename KinematicType >
const std::string& PARTONS::Result< KinematicType >::getComputationModuleName ( ) const
inline

Get name of module used to evaluate this result.

◆ getKinematic()

template<typename KinematicType >
const KinematicType& PARTONS::Result< KinematicType >::getKinematic ( ) const
inline

Get reference to kinematics associated to this result.

◆ getResultInfo()

template<typename KinematicType >
const ResultInfo& PARTONS::Result< KinematicType >::getResultInfo ( ) const
inline

Get information on this result.

◆ operator<()

template<typename KinematicType >
bool PARTONS::Result< KinematicType >::operator< ( const Result< KinematicType > &  other) const
inline

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

Used by std::sort function.

Parameters
otherRight hand value.
Returns
True if the value of left operand is less than the value of right operand, otherwise false.

◆ setComputationModuleName()

template<typename KinematicType >
void PARTONS::Result< KinematicType >::setComputationModuleName ( const std::string &  moduleName)
inline

Set name of module used to evaluate this result.

◆ setKinematic()

template<typename KinematicType >
void PARTONS::Result< KinematicType >::setKinematic ( const KinematicType kinematic)
inline

Set kinematics associated to this result.

◆ setResultInfo()

template<typename KinematicType >
void PARTONS::Result< KinematicType >::setResultInfo ( const ResultInfo resultInfo)
inline

Set information on this result.

◆ toString()

template<typename KinematicType >
virtual std::string PARTONS::Result< KinematicType >::toString ( ) const
inlinevirtual

Member Data Documentation

◆ m_channelType

template<typename KinematicType >
ChannelType::Type PARTONS::Result< KinematicType >::m_channelType
protected

Channel type.

◆ m_computationModuleName

template<typename KinematicType >
std::string PARTONS::Result< KinematicType >::m_computationModuleName
protected

Name of module used to evaluate this result.

◆ m_kinematic

template<typename KinematicType >
KinematicType PARTONS::Result< KinematicType >::m_kinematic
protected

Kinematics associated to this result.

◆ m_resultInfo

template<typename KinematicType >
ResultInfo PARTONS::Result< KinematicType >::m_resultInfo
protected

Information on this result.


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