DepthProbeComputation Class Reference

Performs a single-threaded depth probe computation with given sample. More...

Inheritance diagram for DepthProbeComputation:

Collaboration diagram for DepthProbeComputation:

Public Member Functions
	DepthProbeComputation (const MultiLayer &multilayer, const SimulationOptions &options, ProgressHandler &progress, DepthProbeElementIter begin_it, DepthProbeElementIter end_it)
	~DepthProbeComputation () override
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 Types
using	DepthProbeElementIter = std::vector< DepthProbeElement >::iterator

Private Member Functions
void	runProtected () override

Private Attributes
DepthProbeElementIter	m_begin_it
DepthProbeComputationTerm	m_computation_term
DepthProbeElementIter	m_end_it

Detailed Description

Performs a single-threaded depth probe computation with given sample.

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

Definition at line 34 of file DepthProbeComputation.h.

Member Typedef Documentation

DepthProbeElementIter

using DepthProbeComputation::DepthProbeElementIter = std::vector<DepthProbeElement>::iterator

private

Definition at line 35 of file DepthProbeComputation.h.

Constructor & Destructor Documentation

DepthProbeComputation()

DepthProbeComputation::DepthProbeComputation	(	const MultiLayer &	multilayer,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		DepthProbeElementIter	begin_it,
		DepthProbeElementIter	end_it
	)

Definition at line 25 of file DepthProbeComputation.cpp.

    : IComputation(multilayer, options, progress)
    , m_begin_it(begin_it)
    , m_end_it(end_it)
    , m_computation_term(m_processed_sample.get())
{
}

~DepthProbeComputation()

DepthProbeComputation::~DepthProbeComputation ( )

overridedefault

Member Function Documentation

errorMessage()

std::string IComputation::errorMessage ( ) const

inlineinherited

Definition at line 48 of file IComputation.h.

{ return m_status.errorMessage(); }

References ComputationStatus::errorMessage(), and IComputation::m_status.

Here is the call graph for this function:

isCompleted()

bool IComputation::isCompleted ( ) const

inlineinherited

Definition at line 47 of file IComputation.h.

{ return m_status.isCompleted(); }

References ComputationStatus::isCompleted(), and IComputation::m_status.

Here is the call graph for this function:

run()

void IComputation::run ( )

inherited

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 IComputation::m_status, IComputation::runProtected(), ComputationStatus::setCompleted(), ComputationStatus::setFailed(), and ComputationStatus::setRunning().

Here is the call graph for this function:

runProtected()

void DepthProbeComputation::runProtected ( )

overrideprivatevirtual

Implements IComputation.

Definition at line 39 of file DepthProbeComputation.cpp.

{
    if (!m_progress->alive())
        return;
    m_computation_term.setProgressHandler(m_progress);
    for (auto it = m_begin_it; it != m_end_it; ++it) {
        m_computation_term.compute(*it);
    }
}

References ProgressHandler::alive(), DepthProbeComputationTerm::compute(), m_begin_it, m_computation_term, m_end_it, IComputation::m_progress, and DepthProbeComputationTerm::setProgressHandler().

Here is the call graph for this function:

Member Data Documentation

m_begin_it

DepthProbeElementIter DepthProbeComputation::m_begin_it

private

Definition at line 46 of file DepthProbeComputation.h.

Referenced by runProtected().

m_computation_term

DepthProbeComputationTerm DepthProbeComputation::m_computation_term

private

Definition at line 47 of file DepthProbeComputation.h.

Referenced by runProtected().

m_end_it

DepthProbeElementIter DepthProbeComputation::m_end_it

private

Definition at line 46 of file DepthProbeComputation.h.

Referenced by runProtected().

m_processed_sample

std::unique_ptr<ProcessedSample> IComputation::m_processed_sample

protectedinherited

Definition at line 54 of file IComputation.h.

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

m_progress

ProgressHandler* IComputation::m_progress

protectedinherited

Definition at line 52 of file IComputation.h.

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

m_sim_options

SimulationOptions IComputation::m_sim_options

protectedinherited

Definition at line 51 of file IComputation.h.

Referenced by DWBAComputation::DWBAComputation().

m_status

ComputationStatus IComputation::m_status

protectedinherited

Definition at line 53 of file IComputation.h.

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

---

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

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