IComputation Class Reference

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

Inheritance diagram for IComputation:

Collaboration diagram for IComputation:

Public Member Functions
	IComputation (const MultiLayer &sample, const SimulationOptions &options, ProgressHandler &progress, bool forcePolarized=false)
virtual	~IComputation ()
std::string	errorMessage () const
bool	isCompleted () const
void	run ()

Protected Attributes
std::unique_ptr< ProcessedSample >	m_processed_sample
ProgressHandler *	m_progress
SimulationOptions	m_sim_options
ComputationStatus	m_status

Private Member Functions
virtual void	runProtected ()=0

Detailed Description

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

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

Definition at line 39 of file IComputation.h.

Constructor & Destructor Documentation

IComputation()

IComputation::IComputation	(	const MultiLayer &	sample,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		bool	forcePolarized = false
	)

Definition at line 21 of file IComputation.cpp.

    : m_sim_options(options)
    , m_progress(&progress)
    , m_processed_sample(std::make_unique<ProcessedSample>(sample, options, forcePolarized))
{
}

~IComputation()

IComputation::~IComputation ( )

virtualdefault

Member Function Documentation

errorMessage()

std::string IComputation::errorMessage ( ) const

inline

Definition at line 48 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 47 of file IComputation.h.

{ return m_status.isCompleted(); }

References ComputationStatus::isCompleted(), and m_status.

Here is the call graph for this function:

run()

void IComputation::run

(

)

Definition at line 31 of file IComputation.cpp.

{
    m_status.setRunning();
    try {
        runProtected();
        m_status.setCompleted();
    } catch (const std::exception& ex) {
        m_status.setFailed(ex.what());
    }
}

References m_status, runProtected(), ComputationStatus::setCompleted(), ComputationStatus::setFailed(), and ComputationStatus::setRunning().

Here is the call graph for this function:

runProtected()

virtual void IComputation::runProtected ( )

privatepure virtual

Implemented in SpecularComputation, DWBAComputation, and DepthProbeComputation.

Referenced by run().

Member Data Documentation

m_processed_sample

std::unique_ptr<ProcessedSample> IComputation::m_processed_sample

protected

Definition at line 54 of file IComputation.h.

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

m_progress

ProgressHandler* IComputation::m_progress

protected

Definition at line 52 of file IComputation.h.

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

m_sim_options

SimulationOptions IComputation::m_sim_options

protected

Definition at line 51 of file IComputation.h.

Referenced by DWBAComputation::DWBAComputation().

m_status

ComputationStatus IComputation::m_status

protected

Definition at line 53 of file IComputation.h.

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

---

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

• /home/www/ba/Core/Computation/IComputation.h
• /home/www/ba/Core/Computation/IComputation.cpp