JobWorker.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Support/Data/JobWorker.cpp
//! @brief     Implements class JobWorker
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "GUI/Support/Data/JobWorker.h"
#include "Device/Histo/SimulationResult.h"
#include "Sim/Simulation/ScatteringSimulation.h"
#include <QDateTime>
#include <memory>
#include <utility>
 
JobWorker::JobWorker(QString identifier, ISimulation* simulation)
    : m_identifier(std::move(identifier))
    , m_simulation(simulation)
    , m_percentage_done(0)
    , m_job_status(JobStatus::Idle)
    , m_terminate_request_flag(false)
{
}
 
JobWorker::~JobWorker() = default;
 
QString JobWorker::identifier() const
{
    return m_identifier;
}
 
int JobWorker::progress() const
{
    return m_percentage_done;
}
 
void JobWorker::start()
{
    m_terminate_request_flag = false;
    m_simulation_start = QDateTime::currentDateTime();
    m_simulation_end = QDateTime();
    m_result.release();
    emit started();
 
    if (m_simulation) {
        m_simulation->subscribe([this](size_t percentage_done) {
            return updateProgress(static_cast<int>(percentage_done));
        });
 
        m_job_status = JobStatus::Running;
 
        try {
            SimulationResult result = m_simulation->simulate();
            if (m_job_status != JobStatus::Canceled)
                m_job_status = JobStatus::Completed;
            m_result = std::make_unique<SimulationResult>(std::move(result));
        } catch (const std::exception& ex) {
            m_job_status = JobStatus::Failed;
            m_percentage_done = 100;
            m_failure_message =
                "JobRunner::start() -> ISimulation failed with exception throw:\n\n";
 
            m_failure_message.append(QString(ex.what()));
        }
    } else {
        m_job_status = JobStatus::Failed;
        m_percentage_done = 100;
        m_failure_message = "JobRunner::start() -> Error. ISimulation doesn't exist.";
    }
 
    m_simulation_end = QDateTime::currentDateTime();
    emit progressUpdate();
    emit finished();
}
 
JobStatus JobWorker::status() const
{
    return m_job_status;
}
 
QString JobWorker::failureMessage() const
{
    return m_failure_message;
}
 
const QDateTime& JobWorker::simulationStart() const
{
    return m_simulation_start;
}
 
const QDateTime& JobWorker::simulationEnd() const
{
    return m_simulation_end;
}
 
const SimulationResult* JobWorker::result() const
{
    return m_result.get();
}
 
//! Sets request for JobRunner to terminate underlying domain simulation.
 
void JobWorker::terminate()
{
    m_terminate_request_flag = true;
    m_job_status = JobStatus::Canceled;
}
 
//! Sets current progress. Returns true if we want to continue the simulation.
 
bool JobWorker::updateProgress(int percentage_done)
{
    if (percentage_done > m_percentage_done) {
        m_percentage_done = percentage_done;
        emit progressUpdate();
    }
    return !m_terminate_request_flag;
}