IComputation Class Reference

Description

Interface for a single-threaded computation with given range of DiffuseElements and ProgressHandler.

Controlled by the multi-threading machinery in ISimulation::runSingleSimulation().

Definition at line 37 of file IComputation.h.

Inheritance diagram for IComputation:

Collaboration diagram for IComputation:

Public Member Functions
	IComputation (const reSample &re_sample, const SimulationOptions &options, ProgressHandler &progress)
virtual	~IComputation ()
void	compute ()
	Calls runProtected(), catches exceptions, sets m_status. More...
std::string	errorMessage () const
bool	isCompleted () const

Protected Member Functions
void	setProgressHandler (ProgressHandler *progress) const
void	stepProgress () const

Protected Attributes
const SimulationOptions &	m_options
ProgressHandler *	m_progress
const reSample &	m_re_sample
ComputationStatus	m_status

Private Member Functions
virtual void	runProtected ()=0
	Runs computation. May throw. To be called from run(), which catches exceptions. More...

Private Attributes
std::unique_ptr< DelayedProgressCounter >	m_progress_counter

Constructor & Destructor Documentation

IComputation()

IComputation::IComputation	(	const reSample &	re_sample,
		const SimulationOptions &	options,
		ProgressHandler &	progress
	)

Definition at line 20 of file IComputation.cpp.

    : m_re_sample(re_sample)
    , m_options(options)
    , m_progress(&progress)
{
}

~IComputation()

IComputation::~IComputation ( )

virtualdefault

Member Function Documentation

compute()

void IComputation::compute

(

)

Calls runProtected(), catches exceptions, sets m_status.

Definition at line 41 of file IComputation.cpp.

{
    m_status.setRunning();
    try {
        if (!m_progress->alive())
            return;
        setProgressHandler(m_progress);
 
        runProtected(); // <--- here the main work is done
 
        m_status.setCompleted();
    } catch (const std::exception& ex) {
        m_status.setFailed(ex.what());
    }
}

References ProgressHandler::alive(), m_progress, m_status, runProtected(), ComputationStatus::setCompleted(), ComputationStatus::setFailed(), setProgressHandler(), and ComputationStatus::setRunning().

Here is the call graph for this function:

errorMessage()

std::string IComputation::errorMessage ( ) const

inline

Definition at line 47 of file IComputation.h.

{ return m_status.errorMessage(); }

References ComputationStatus::errorMessage(), and m_status.

Here is the call graph for this function:

isCompleted()

bool IComputation::isCompleted ( ) const

inline

Definition at line 46 of file IComputation.h.

{ return m_status.isCompleted(); }

References ComputationStatus::isCompleted(), and m_status.

Here is the call graph for this function:

runProtected()

virtual void IComputation::runProtected ( )

privatepure virtual

Runs computation. May throw. To be called from run(), which catches exceptions.

Implemented in SpecularComputation, DWBAComputation, and DepthProbeComputation.

Referenced by compute().

setProgressHandler()

void IComputation::setProgressHandler ( ProgressHandler *  progress ) const

protected

Definition at line 30 of file IComputation.cpp.

{
    m_progress_counter = std::make_unique<DelayedProgressCounter>(progress, 100);
}

References m_progress_counter.

Referenced by compute().

stepProgress()

void IComputation::stepProgress ( ) const

protected

Definition at line 35 of file IComputation.cpp.

{
    if (m_progress_counter)
        m_progress_counter->stepProgress();
}

References m_progress_counter.

Referenced by DepthProbeComputation::runProtected(), DWBAComputation::runProtected(), and SpecularComputation::runProtected().

Member Data Documentation

m_options

const SimulationOptions& IComputation::m_options

protected

Definition at line 54 of file IComputation.h.

m_progress

ProgressHandler* IComputation::m_progress

protected

Definition at line 55 of file IComputation.h.

Referenced by compute(), and DWBAComputation::runProtected().

m_progress_counter

std::unique_ptr<DelayedProgressCounter> IComputation::m_progress_counter

mutableprivate

Definition at line 62 of file IComputation.h.

Referenced by setProgressHandler(), and stepProgress().

m_re_sample

const reSample& IComputation::m_re_sample

protected

Definition at line 53 of file IComputation.h.

Referenced by DepthProbeComputation::runProtected(), DWBAComputation::runProtected(), and SpecularComputation::runProtected().

m_status

ComputationStatus IComputation::m_status

protected

Definition at line 56 of file IComputation.h.

Referenced by compute(), errorMessage(), and isCompleted().

---

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

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