JobWorker Class Reference

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

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 (const QString &identifier, ISimulation *simulation)
QString	failureMessage () const
QString	identifier () const
int	progress () const
int	simulationDuration () const
QString	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
QString	m_job_status
int	m_percentage_done
ISimulation *	m_simulation
int	m_simulation_duration
bool	m_terminate_request_flag

Detailed Description

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

Definition at line 24 of file JobWorker.h.

Constructor & Destructor Documentation

JobWorker()

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

Definition at line 20 of file JobWorker.cpp.

    : m_identifier(identifier)
    , m_simulation(simulation)
    , m_percentage_done(0)
    , m_job_status("Idle")
    , m_terminate_request_flag(false)
    , m_simulation_duration(0)
{
}

Member Function Documentation

failureMessage()

QString JobWorker::failureMessage

(

)

const

Definition at line 86 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 30 of file JobWorker.cpp.

{
    return m_identifier;
}

References m_identifier.

Referenced by JobQueueData::processFinishedJob().

progress()

int JobWorker::progress

(

)

const

Definition at line 35 of file JobWorker.cpp.

{
    return m_percentage_done;
}

References m_percentage_done.

progressUpdate

void JobWorker::progressUpdate ( )

signal

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

simulationDuration()

int JobWorker::simulationDuration

(

)

const

Definition at line 91 of file JobWorker.cpp.

{
    return m_simulation_duration;
}

References m_simulation_duration.

Referenced by JobQueueData::processFinishedJob().

start

void JobWorker::start ( )

slot

Definition at line 40 of file JobWorker.cpp.

{
    m_terminate_request_flag = false;
    m_simulation_duration = 0;
    emit started();
 
    if (m_simulation) {
        m_simulation->subscribe([this](size_t percentage_done) {
            return updateProgress(static_cast<int>(percentage_done));
        });
 
        m_job_status = "Running";
 
        try {
            QDateTime beginTime = QDateTime::currentDateTime();
            m_simulation->runSimulation();
            if (m_job_status != "Canceled")
                m_job_status = "Completed";
 
            QDateTime endTime = QDateTime::currentDateTime();
            m_simulation_duration = static_cast<int>(beginTime.msecsTo(endTime));
 
        } catch (const std::exception& ex) {
            m_job_status = "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 = "Failed";
        m_percentage_done = 100;
        m_failure_message = "JobRunner::start() -> Error. ISimulation doesn't exist.";
    }
 
    emit progressUpdate();
    emit finished();
}

References GUIHelpers::currentDateTime(), finished(), m_failure_message, m_job_status, m_percentage_done, m_simulation, m_simulation_duration, m_terminate_request_flag, progressUpdate(), ISimulation::runSimulation(), started(), ISimulation::subscribe(), 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()

QString JobWorker::status

(

)

const

Definition at line 81 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 98 of file JobWorker.cpp.

{
    m_terminate_request_flag = true;
    m_job_status = "Canceled";
}

References 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 106 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 56 of file JobWorker.h.

Referenced by failureMessage(), and start().

m_identifier

QString JobWorker::m_identifier

private

Definition at line 51 of file JobWorker.h.

Referenced by identifier().

m_job_status

QString JobWorker::m_job_status

private

Definition at line 54 of file JobWorker.h.

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

m_percentage_done

int JobWorker::m_percentage_done

private

Definition at line 53 of file JobWorker.h.

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

m_simulation

ISimulation* JobWorker::m_simulation

private

Definition at line 52 of file JobWorker.h.

Referenced by start().

m_simulation_duration

int JobWorker::m_simulation_duration

private

Definition at line 57 of file JobWorker.h.

Referenced by simulationDuration(), and start().

m_terminate_request_flag

bool JobWorker::m_terminate_request_flag

private

Definition at line 55 of file JobWorker.h.

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

---

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

• /home/www/ba/GUI/coregui/Models/JobWorker.h
• /home/www/ba/GUI/coregui/Models/JobWorker.cpp