ComputationStatus.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Core/Computation/ComputationStatus.h
//! @brief     Defines and implements interface class ComputationStatus.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_CORE_COMPUTATION_COMPUTATIONSTATUS_H
#define BORNAGAIN_CORE_COMPUTATION_COMPUTATIONSTATUS_H
 
#include <string>
 
//! Completion status (flag and text) of a numeric computation.
//! @ingroup algorithms_internal
 
class ComputationStatus {
public:
    ComputationStatus() : m_status(IDLE) {}
 
    bool isCompleted() const { return m_status == COMPLETED; }
    std::string errorMessage() const { return m_error_message; }
 
    void setRunning() { m_status = RUNNING; }
    void setCompleted() { m_status = COMPLETED; }
    void setFailed(const std::string& message)
    {
        m_error_message = message;
        m_status = FAILED;
    }
 
private:
    enum ESimulationStatus { IDLE, RUNNING, COMPLETED, FAILED };
 
    ESimulationStatus m_status;
    std::string m_error_message;
};
 
#endif // BORNAGAIN_CORE_COMPUTATION_COMPUTATIONSTATUS_H
#endif // USER_API