JobWorker Class Reference

Description

The JobWorker class provides running the domain simulation in a thread.

Definition at line 28 of file JobWorker.h.

Inheritance diagram for JobWorker:

Collaboration diagram for JobWorker:

Public Slots
void	start ()
void	terminate ()
	Sets request for JobRunner to terminate underlying domain simulation. More...

Signals
void	finished ()
void	progressUpdate ()
void	started ()

Public Member Functions
	JobWorker (QString identifier, ISimulation *simulation)
	~JobWorker ()
QString	failureMessage () const
QString	identifier () const
int	progress () const
const SimulationResult *	result () const
const QDateTime &	simulationEnd () const
const QDateTime &	simulationStart () const
JobStatus	status () const

Private Member Functions
bool	updateProgress (int percentage_done)
	Sets current progress. Returns true if we want to continue the simulation. More...

Private Attributes
QString	m_failure_message
QString	m_identifier
JobStatus	m_job_status
int	m_percentage_done
std::unique_ptr< const SimulationResult >	m_result
ISimulation *	m_simulation
QDateTime	m_simulation_end
QDateTime	m_simulation_start
bool	m_terminate_request_flag

Constructor & Destructor Documentation

JobWorker()

JobWorker::JobWorker	(	QString	identifier,
		ISimulation *	simulation
	)

Definition at line 22 of file JobWorker.cpp.

    : m_identifier(std::move(identifier))
    , m_simulation(simulation)
    , m_percentage_done(0)
    , m_job_status(JobStatus::Idle)
    , m_terminate_request_flag(false)
{
}

References Idle.

~JobWorker()

JobWorker::~JobWorker ( )

default

Member Function Documentation

failureMessage()

QString JobWorker::failureMessage

(

)

const

Definition at line 87 of file JobWorker.cpp.

{
    return m_failure_message;
}

References m_failure_message.

Referenced by JobQueueData::processFinishedJob().

finished

void JobWorker::finished ( )

signal

Referenced by JobQueueData::runJob(), and start().

identifier()

QString JobWorker::identifier

(

)

const

Definition at line 33 of file JobWorker.cpp.

{
    return m_identifier;
}

References m_identifier.

progress()

int JobWorker::progress

(

)

const

Definition at line 38 of file JobWorker.cpp.

{
    return m_percentage_done;
}

References m_percentage_done.

progressUpdate

void JobWorker::progressUpdate ( )

signal

Referenced by JobQueueData::runJob(), start(), and updateProgress().

result()

const SimulationResult * JobWorker::result

(

)

const

Definition at line 102 of file JobWorker.cpp.

{
    return m_result.get();
}

References m_result.

Referenced by JobQueueData::processFinishedJob(), and start().

simulationEnd()

const QDateTime & JobWorker::simulationEnd

(

)

const

Definition at line 97 of file JobWorker.cpp.

{
    return m_simulation_end;
}

References m_simulation_end.

Referenced by JobQueueData::processFinishedJob().

simulationStart()

const QDateTime & JobWorker::simulationStart

(

)

const

Definition at line 92 of file JobWorker.cpp.

{
    return m_simulation_start;
}

References m_simulation_start.

start

void JobWorker::start ( )

slot

Definition at line 43 of file JobWorker.cpp.

{
    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();
}

References Canceled, Completed, Failed, finished(), m_failure_message, m_job_status, m_percentage_done, m_result, m_simulation, m_simulation_end, m_simulation_start, m_terminate_request_flag, progressUpdate(), result(), Running, started(), and updateProgress().

Referenced by JobQueueData::runJob().

Here is the call graph for this function:

started

void JobWorker::started ( )

signal

Referenced by JobQueueData::runJob(), and start().

status()

JobStatus JobWorker::status

(

)

const

Definition at line 82 of file JobWorker.cpp.

{
    return m_job_status;
}

References m_job_status.

Referenced by JobQueueData::processFinishedJob().

terminate

void JobWorker::terminate ( )

slot

Sets request for JobRunner to terminate underlying domain simulation.

Definition at line 109 of file JobWorker.cpp.

{
    m_terminate_request_flag = true;
    m_job_status = JobStatus::Canceled;
}

References Canceled, m_job_status, and m_terminate_request_flag.

Referenced by JobQueueData::cancelJob().

updateProgress()

bool JobWorker::updateProgress ( int  percentage_done )

private

Sets current progress. Returns true if we want to continue the simulation.

Definition at line 117 of file JobWorker.cpp.

{
    if (percentage_done > m_percentage_done) {
        m_percentage_done = percentage_done;
        emit progressUpdate();
    }
    return !m_terminate_request_flag;
}

References m_percentage_done, m_terminate_request_flag, and progressUpdate().

Referenced by start().

Member Data Documentation

m_failure_message

QString JobWorker::m_failure_message

private

Definition at line 64 of file JobWorker.h.

Referenced by failureMessage(), and start().

m_identifier

QString JobWorker::m_identifier

private

Definition at line 59 of file JobWorker.h.

Referenced by identifier().

m_job_status

JobStatus JobWorker::m_job_status

private

Definition at line 62 of file JobWorker.h.

Referenced by start(), status(), and terminate().

m_percentage_done

int JobWorker::m_percentage_done

private

Definition at line 61 of file JobWorker.h.

Referenced by progress(), start(), and updateProgress().

m_result

std::unique_ptr<const SimulationResult> JobWorker::m_result

private

Definition at line 67 of file JobWorker.h.

Referenced by result(), and start().

m_simulation

ISimulation* JobWorker::m_simulation

private

Definition at line 60 of file JobWorker.h.

Referenced by start().

m_simulation_end

QDateTime JobWorker::m_simulation_end

private

Definition at line 66 of file JobWorker.h.

Referenced by simulationEnd(), and start().

m_simulation_start

QDateTime JobWorker::m_simulation_start

private

Definition at line 65 of file JobWorker.h.

Referenced by simulationStart(), and start().

m_terminate_request_flag

bool JobWorker::m_terminate_request_flag

private

Definition at line 63 of file JobWorker.h.

Referenced by start(), terminate(), and updateProgress().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/Data/JobWorker.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/Data/JobWorker.cpp