BornAgain
1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ComputationStatus.h
Go to the documentation of this file.
1
// ************************************************************************** //
2
//
3
// BornAgain: simulate and fit scattering at grazing incidence
4
//
5
//! @file Core/Computation/ComputationStatus.h
6
//! @brief Defines and implements interface class ComputationStatus.
7
//!
8
//! @homepage http://www.bornagainproject.org
9
//! @license GNU General Public License v3 or higher (see COPYING)
10
//! @copyright Forschungszentrum Jülich GmbH 2018
11
//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12
//
13
// ************************************************************************** //
14
15
#ifndef BORNAGAIN_CORE_COMPUTATION_COMPUTATIONSTATUS_H
16
#define BORNAGAIN_CORE_COMPUTATION_COMPUTATIONSTATUS_H
17
18
#include <string>
19
20
//! Completion status (flag and text) of a numeric computation.
21
//! @ingroup algorithms_internal
22
23
class
ComputationStatus
24
{
25
public
:
26
ComputationStatus
() :
m_status
(
IDLE
) {}
27
28
bool
isCompleted
()
const
{
return
m_status
==
COMPLETED
; }
29
std::string
errorMessage
()
const
{
return
m_error_message
; }
30
31
void
setRunning
() {
m_status
=
RUNNING
; }
32
void
setCompleted
() {
m_status
=
COMPLETED
; }
33
void
setFailed
() {
m_status
=
FAILED
; }
34
void
setErrorMessage
(
const
std::string& message) {
m_error_message
= message; }
35
36
private
:
37
enum
ESimulationStatus
{
IDLE
,
RUNNING
,
COMPLETED
,
FAILED
};
38
39
ESimulationStatus
m_status
;
40
std::string
m_error_message
;
41
};
42
43
#endif
// BORNAGAIN_CORE_COMPUTATION_COMPUTATIONSTATUS_H
ComputationStatus
Completion status (flag and text) of a numeric computation.
Definition:
ComputationStatus.h:24
ComputationStatus::setRunning
void setRunning()
Definition:
ComputationStatus.h:31
ComputationStatus::setFailed
void setFailed()
Definition:
ComputationStatus.h:33
ComputationStatus::errorMessage
std::string errorMessage() const
Definition:
ComputationStatus.h:29
ComputationStatus::setCompleted
void setCompleted()
Definition:
ComputationStatus.h:32
ComputationStatus::ESimulationStatus
ESimulationStatus
Definition:
ComputationStatus.h:37
ComputationStatus::RUNNING
@ RUNNING
Definition:
ComputationStatus.h:37
ComputationStatus::FAILED
@ FAILED
Definition:
ComputationStatus.h:37
ComputationStatus::IDLE
@ IDLE
Definition:
ComputationStatus.h:37
ComputationStatus::COMPLETED
@ COMPLETED
Definition:
ComputationStatus.h:37
ComputationStatus::m_status
ESimulationStatus m_status
Definition:
ComputationStatus.h:39
ComputationStatus::setErrorMessage
void setErrorMessage(const std::string &message)
Definition:
ComputationStatus.h:34
ComputationStatus::isCompleted
bool isCompleted() const
Definition:
ComputationStatus.h:28
ComputationStatus::ComputationStatus
ComputationStatus()
Definition:
ComputationStatus.h:26
ComputationStatus::m_error_message
std::string m_error_message
Definition:
ComputationStatus.h:40
Core
Computation
ComputationStatus.h
Generated by
1.9.1