ComputationStatus Class Reference

Description

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

Definition at line 27 of file ComputationStatus.h.

Collaboration diagram for ComputationStatus:

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

Private Types
enum	ESimulationStatus { IDLE , RUNNING , COMPLETED , FAILED }

Private Attributes
std::string	m_error_message
ESimulationStatus	m_status

Member Enumeration Documentation

ESimulationStatus

enum ComputationStatus::ESimulationStatus

private

Enumerator
IDLE
RUNNING
COMPLETED
FAILED

Definition at line 46 of file ComputationStatus.h.

{ IDLE, RUNNING, COMPLETED, FAILED };

Constructor & Destructor Documentation

ComputationStatus()

ComputationStatus::ComputationStatus ( )

inline

Definition at line 29 of file ComputationStatus.h.

        : m_status(IDLE)
    {
    }

Member Function Documentation

errorMessage()

std::string ComputationStatus::errorMessage ( ) const

inline

Definition at line 35 of file ComputationStatus.h.

{ return m_error_message; }

References m_error_message.

Referenced by IComputation::errorMessage().

isCompleted()

bool ComputationStatus::isCompleted ( ) const

inline

Definition at line 34 of file ComputationStatus.h.

{ return m_status == COMPLETED; }

References COMPLETED, and m_status.

Referenced by IComputation::isCompleted().

setCompleted()

void ComputationStatus::setCompleted ( )

inline

Definition at line 38 of file ComputationStatus.h.

{ m_status = COMPLETED; }

References COMPLETED, and m_status.

Referenced by IComputation::compute().

setFailed()

void ComputationStatus::setFailed ( const std::string &  message )

inline

Definition at line 39 of file ComputationStatus.h.

    {
        m_error_message = message;
        m_status = FAILED;
    }

References FAILED, m_error_message, and m_status.

Referenced by IComputation::compute().

setRunning()

void ComputationStatus::setRunning ( )

inline

Definition at line 37 of file ComputationStatus.h.

{ m_status = RUNNING; }

References m_status, and RUNNING.

Referenced by IComputation::compute().

Member Data Documentation

m_error_message

std::string ComputationStatus::m_error_message

private

Definition at line 49 of file ComputationStatus.h.

Referenced by errorMessage(), and setFailed().

m_status

ESimulationStatus ComputationStatus::m_status

private

Definition at line 48 of file ComputationStatus.h.

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

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Computation/ComputationStatus.h