beans/system/ResultInfo.h

0001 /*
0002  * ResultInfo.h
0003  *
0004  *  Created on: May 20, 2016
0005  *      Author: debian
0006  */
0007
0008 #ifndef RESULT_INFO_H
0009 #define RESULT_INFO_H
0010
0011 #include <string>
0012
0013 #include "../Computation.h"
0014
0015 namespace PARTONS {
0016
0017 /**
0018  * @class ResultInfo
0019  *
0020  * @brief Class storing information associated to result evaluation.
0021  *
0022  * 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.
0023  */
0024 class ResultInfo: public BaseObject {
0025
0026 public:
0027
0028     /**
0029      * Default constructor.
0030      */
0031     ResultInfo();
0032
0033     /**
0034      * Copy constructor.
0035      * @param other Object to be copied.
0036      */
0037     ResultInfo(const ResultInfo &other);
0038
0039     /**
0040      * Destructor.
0041      */
0042     virtual ~ResultInfo();
0043
0044     virtual std::string toString() const;
0045
0046     //********************************************************
0047     //*** SETTERS AND GETTERS ********************************
0048     //********************************************************
0049
0050     /**
0051      * Get computation information associated to the corresponding result.
0052      */
0053     const Computation& getComputation() const;
0054
0055     /**
0056      * Set computation information associated to the corresponding result.
0057      */
0058     void setComputation(const Computation& computation);
0059
0060     /**
0061      * Get hash sum of scenario associated to the corresponding result.
0062      */
0063     const std::string& getScenarioHashSum() const;
0064
0065     /**
0066      * Set hash sum of scenario associated to the corresponding result.
0067      */
0068     void setScenarioHashSum(const std::string& scenarioHashSum);
0069
0070     /**
0071      * Get hash sum of environment configuration associated to the corresponding result.
0072      */
0073     const std::string& getEnvironmentConfigurationHashSum() const;
0074
0075     /**
0076      * Set hash sum of environment configuration associated to the corresponding result.
0077      */
0078     void setEnvironmentConfigurationHashSum(
0079             const std::string& environmentConfigurationHashSum);
0080
0081     /**
0082      * Get id of task used to evaluate the corresponding result.
0083      */
0084     unsigned int getScenarioTaskIndexNumber() const;
0085
0086     /**
0087      * Set id of task used to evaluate the corresponding result.
0088      */
0089     void setScenarioTaskIndexNumber(unsigned int scenarioTaskIndexNumber);
0090
0091 private:
0092
0093     /**
0094      * Computation information associated to the corresponding result.
0095      */
0096     Computation m_computation;
0097
0098     /**
0099      * Hash sum of scenario associated to the corresponding result.
0100      */
0101     std::string m_scenarioHashSum;
0102
0103     /**
0104      * Hash sum of environment configuration associated to the corresponding result.
0105      */
0106     std::string m_environmentConfigurationHashSum;
0107
0108     /**
0109      * Id of task used to evaluate the corresponding result.
0110      */
0111     unsigned int m_scenarioTaskIndexNumber;
0112 };
0113
0114 } /* namespace PARTONS */
0115
0116 #endif /* RESULT_INFO_H */