BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Private Types | Private Attributes | List of all members
ComputationStatus Class Reference
Collaboration diagram for ComputationStatus:

Public Member Functions

 ComputationStatus ()
 
bool isCompleted () const
 
std::string errorMessage () const
 
void setRunning ()
 
void setCompleted ()
 
void setFailed ()
 
void setErrorMessage (const std::string &message)
 

Private Types

enum  ESimulationStatus { IDLE , RUNNING , COMPLETED , FAILED }
 

Private Attributes

ESimulationStatus m_status
 
std::string m_error_message
 

Detailed Description

Completion status (flag and text) of a numeric computation.

Definition at line 23 of file ComputationStatus.h.

Member Enumeration Documentation

◆ ESimulationStatus

enum ComputationStatus::ESimulationStatus
private
Enumerator
IDLE 
RUNNING 
COMPLETED 
FAILED 

Definition at line 37 of file ComputationStatus.h.

37 { IDLE, RUNNING, COMPLETED, FAILED };

Constructor & Destructor Documentation

◆ ComputationStatus()

ComputationStatus::ComputationStatus ( )
inline

Definition at line 26 of file ComputationStatus.h.

26 : m_status(IDLE) {}
ComputationStatus::m_status
ESimulationStatus m_status
Definition: ComputationStatus.h:39

Member Function Documentation

◆ isCompleted()

bool ComputationStatus::isCompleted ( ) const
inline

Definition at line 28 of file ComputationStatus.h.

28 { return m_status == COMPLETED; }

References COMPLETED, and m_status.

Referenced by IComputation::isCompleted().

◆ errorMessage()

std::string ComputationStatus::errorMessage ( ) const
inline

Definition at line 29 of file ComputationStatus.h.

29 { return m_error_message; }
ComputationStatus::m_error_message
std::string m_error_message
Definition: ComputationStatus.h:40

References m_error_message.

Referenced by IComputation::errorMessage().

◆ setRunning()

void ComputationStatus::setRunning ( )
inline

Definition at line 31 of file ComputationStatus.h.

31 { m_status = RUNNING; }

References m_status, and RUNNING.

Referenced by IComputation::run().

◆ setCompleted()

void ComputationStatus::setCompleted ( )
inline

Definition at line 32 of file ComputationStatus.h.

32 { m_status = COMPLETED; }

References COMPLETED, and m_status.

Referenced by IComputation::run().

◆ setFailed()

void ComputationStatus::setFailed ( )
inline

Definition at line 33 of file ComputationStatus.h.

33 { m_status = FAILED; }

References FAILED, and m_status.

Referenced by IComputation::run().

◆ setErrorMessage()

void ComputationStatus::setErrorMessage ( const std::string &  message)
inline

Definition at line 34 of file ComputationStatus.h.

34 { m_error_message = message; }

References m_error_message.

Referenced by IComputation::run().

Member Data Documentation

◆ m_status

ESimulationStatus ComputationStatus::m_status
private

Definition at line 39 of file ComputationStatus.h.

Referenced by isCompleted(), setCompleted(), setFailed(), and setRunning().

◆ m_error_message

std::string ComputationStatus::m_error_message
private

Definition at line 40 of file ComputationStatus.h.

Referenced by errorMessage(), and setErrorMessage().

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