JobQueueData Class Reference

Description

The JobQueueData class holds all objects/logic to run simulation in a thread.

Definition at line 28 of file JobQueueData.h.

Inheritance diagram for JobQueueData:

Collaboration diagram for JobQueueData:

Public Slots
void	cancelJob (const QString &identifier)
	Cancels running job. More...
void	onCancelAllJobs ()
	Cancels all running jobs. More...
void	onFinishedJob ()
	Performs necessary actions when job is finished. More...
void	onFinishedThread ()
void	onProgressUpdate ()
void	onStartedJob ()
	Sets JobItem properties when the job is going to start. More...
void	removeJob (const QString &identifier)
	Remove job from list completely. More...
void	runJob (JobItem *jobItem)
	Submits job and run it in a thread. More...

Signals
void	focusRequest (JobItem *jobItem)
void	globalProgress (int)

Public Member Functions
	JobQueueData (JobModel *jobModel)
bool	hasUnfinishedJobs ()

Private Member Functions
void	assignForDeletion (JobWorker *worker)
	Removes JobRunner from the map of known runners, assigns it for deletion. More...
void	assignForDeletion (QThread *thread)
	Removes QThread from the map of known threads, assigns it for deletion. More...
void	clearSimulation (const QString &identifier)
ISimulation *	getSimulation (const QString &identifier)
	Returns the simulation (if exists) for given identifier. More...
QThread *	getThread (const QString &identifier)
	Returns the thread for given identifier. More...
JobWorker *	getWorker (const QString &identifier)
	Returns job runner for given identifier. More...
void	processFinishedJob (JobWorker *worker, JobItem *jobItem)
	Set all data of finished job. More...
void	updateGlobalProgress ()
	Estimates global progress from the progress of multiple running jobs and emits appropriate signal. More...

Private Attributes
JobModel *	m_jobModel
	job identifier to simulation More...
QMap< QString, ISimulation * >	m_simulations
	job identifier to jobWorker More...
QMap< QString, QThread * >	m_threads
QMap< QString, JobWorker * >	m_workers
	job identifier to the thread More...

Constructor & Destructor Documentation

JobQueueData()

JobQueueData::JobQueueData

(

JobModel *

jobModel

)

Definition at line 26 of file JobQueueData.cpp.

    : m_jobModel(jobModel)
{
}

Member Function Documentation

assignForDeletion() [1/2]

void JobQueueData::assignForDeletion ( JobWorker *  worker )

private

Removes JobRunner from the map of known runners, assigns it for deletion.

Definition at line 197 of file JobQueueData.cpp.

{
    ASSERT(worker);
    worker->disconnect();
    for (auto it = m_workers.begin(); it != m_workers.end(); ++it) {
        if (it.value() == worker) {
            m_workers.erase(it);
            delete worker;
            return;
        }
    }
 
    throw Error("JobQueueData::assignForDeletion() -> Error! Can't find the runner.");
}

References Error, and m_workers.

assignForDeletion() [2/2]

void JobQueueData::assignForDeletion ( QThread *  thread )

private

Removes QThread from the map of known threads, assigns it for deletion.

Definition at line 182 of file JobQueueData.cpp.

{
    for (auto it = m_threads.begin(); it != m_threads.end(); ++it) {
        if (it.value() == thread) {
            thread->deleteLater();
            m_threads.erase(it);
            return;
        }
    }
 
    throw Error("JobQueueData::assignForDeletion() -> Error! Can't find thread.");
}

References Error, and m_threads.

Referenced by onFinishedJob(), and onFinishedThread().

cancelJob

void JobQueueData::cancelJob ( const QString &  identifier )

slot

Cancels running job.

Definition at line 88 of file JobQueueData.cpp.

{
    if (getThread(identifier))
        getWorker(identifier)->terminate();
}

References getThread(), getWorker(), and JobWorker::terminate().

Referenced by JobModel::cancelJob(), onCancelAllJobs(), and removeJob().

Here is the call graph for this function:

clearSimulation()

void JobQueueData::clearSimulation ( const QString &  identifier )

private

Definition at line 212 of file JobQueueData.cpp.

{
    auto* simulation = getSimulation(identifier);
    m_simulations.remove(identifier);
    delete simulation;
}

References getSimulation(), and m_simulations.

Referenced by onFinishedJob(), and removeJob().

Here is the call graph for this function:

focusRequest

void JobQueueData::focusRequest ( JobItem *  jobItem )

signal

Referenced by JobModel::JobModel(), onFinishedJob(), and runJob().

getSimulation()

ISimulation * JobQueueData::getSimulation ( const QString &  identifier )

private

Returns the simulation (if exists) for given identifier.

Definition at line 257 of file JobQueueData.cpp.

{
    auto it = m_simulations.find(identifier);
    return it != m_simulations.end() ? it.value() : nullptr;
}

References m_simulations.

Referenced by clearSimulation(), and runJob().

getThread()

QThread * JobQueueData::getThread ( const QString &  identifier )

private

Returns the thread for given identifier.

Definition at line 241 of file JobQueueData.cpp.

{
    auto it = m_threads.find(identifier);
    return it != m_threads.end() ? it.value() : nullptr;
}

References m_threads.

Referenced by cancelJob(), onFinishedJob(), and runJob().

getWorker()

JobWorker * JobQueueData::getWorker ( const QString &  identifier )

private

Returns job runner for given identifier.

Definition at line 249 of file JobQueueData.cpp.

{
    auto it = m_workers.find(identifier);
    return it != m_workers.end() ? it.value() : nullptr;
}

References m_workers.

Referenced by cancelJob().

globalProgress

void JobQueueData::globalProgress ( int  )

signal

Referenced by JobModel::JobModel(), onFinishedJob(), and updateGlobalProgress().

hasUnfinishedJobs()

bool JobQueueData::hasUnfinishedJobs

(

)

Definition at line 31 of file JobQueueData.cpp.

{
    return !m_simulations.empty();
}

References m_simulations.

Referenced by JobModel::hasUnfinishedJobs(), and onFinishedJob().

onCancelAllJobs

void JobQueueData::onCancelAllJobs ( )

slot

Cancels all running jobs.

Definition at line 174 of file JobQueueData.cpp.

{
    for (const auto& key : m_threads.keys())
        cancelJob(key);
}

References cancelJob(), and m_threads.

Here is the call graph for this function:

onFinishedJob

void JobQueueData::onFinishedJob ( )

slot

Performs necessary actions when job is finished.

Definition at line 117 of file JobQueueData.cpp.

{
    auto* worker = qobject_cast<JobWorker*>(sender());
 
    auto* jobItem = m_jobModel->getJobItemForIdentifier(worker->identifier());
    processFinishedJob(worker, jobItem);
 
    // I tell to the thread to exit here (instead of connecting JobRunner::finished
    // to the QThread::quit because of strange behaviour)
    getThread(worker->identifier())->quit();
 
    emit focusRequest(jobItem);
 
    clearSimulation(worker->identifier());
    assignForDeletion(worker);
 
    if (!hasUnfinishedJobs())
        emit globalProgress(100);
}

References assignForDeletion(), clearSimulation(), focusRequest(), JobModel::getJobItemForIdentifier(), getThread(), globalProgress(), hasUnfinishedJobs(), m_jobModel, and processFinishedJob().

Referenced by runJob().

Here is the call graph for this function:

onFinishedThread

void JobQueueData::onFinishedThread ( )

slot

Definition at line 137 of file JobQueueData.cpp.

{
    auto* thread = qobject_cast<QThread*>(sender());
    assignForDeletion(thread);
}

References assignForDeletion().

Referenced by runJob().

Here is the call graph for this function:

onProgressUpdate

void JobQueueData::onProgressUpdate ( )

slot

Definition at line 143 of file JobQueueData.cpp.

{
    auto* worker = qobject_cast<JobWorker*>(sender());
    auto* jobItem = m_jobModel->getJobItemForIdentifier(worker->identifier());
    jobItem->setProgress(worker->progress());
    updateGlobalProgress();
}

References JobModel::getJobItemForIdentifier(), m_jobModel, JobItem::setProgress(), and updateGlobalProgress().

Referenced by runJob().

Here is the call graph for this function:

onStartedJob

void JobQueueData::onStartedJob ( )

slot

Sets JobItem properties when the job is going to start.

Definition at line 104 of file JobQueueData.cpp.

{
    auto* worker = qobject_cast<JobWorker*>(sender());
 
    auto* jobItem = m_jobModel->getJobItemForIdentifier(worker->identifier());
    jobItem->setProgress(0);
    jobItem->setStatus(JobStatus::Running);
    jobItem->setBeginTime(worker->simulationStart());
    jobItem->setEndTime(QDateTime());
}

References JobModel::getJobItemForIdentifier(), m_jobModel, Running, and JobItem::setProgress().

Referenced by runJob().

Here is the call graph for this function:

processFinishedJob()

void JobQueueData::processFinishedJob ( JobWorker *  worker, JobItem *  jobItem  )

private

Set all data of finished job.

Definition at line 221 of file JobQueueData.cpp.

{
    jobItem->setEndTime(worker->simulationEnd());
 
    // propagating status of runner
    if (worker->status() == JobStatus::Failed)
        jobItem->setComments(worker->failureMessage());
    else {
        ASSERT(worker->result());
        jobItem->setResults(*worker->result());
    }
    jobItem->setStatus(worker->status());
 
    // fixing job progress (if job was successfull, but due to wrong estimation, progress not 100%)
    if (jobItem->isCompleted())
        jobItem->setProgress(100);
}

References Failed, JobWorker::failureMessage(), JobItem::isCompleted(), JobWorker::result(), JobItem::setComments(), JobItem::setEndTime(), JobItem::setProgress(), JobItem::setResults(), JobItem::setStatus(), JobWorker::simulationEnd(), and JobWorker::status().

Referenced by onFinishedJob().

Here is the call graph for this function:

removeJob

void JobQueueData::removeJob ( const QString &  identifier )

slot

Remove job from list completely.

Definition at line 96 of file JobQueueData.cpp.

{
    cancelJob(identifier);
    clearSimulation(identifier);
}

References cancelJob(), and clearSimulation().

Referenced by JobModel::removeJob().

Here is the call graph for this function:

runJob

void JobQueueData::runJob ( JobItem *  jobItem )

slot

Submits job and run it in a thread.

Definition at line 38 of file JobQueueData.cpp.

{
    QString identifier = jobItem->getIdentifier();
    if (getThread(identifier))
        return;
 
    if (getSimulation(identifier))
        throw Error("JobQueueData::runJob() -> Error. ISimulation is already existing.");
 
    try {
        auto simulation = GUI::Transform::ToCore::itemsToSimulation(
            jobItem->sampleItem(), jobItem->instrumentItem(), jobItem->simulationOptionsItem());
        m_simulations[identifier] = simulation.release();
    } catch (const std::exception& ex) {
        QString message("JobQueueData::runJob() -> Error. "
                        "Attempt to create sample/instrument object from user description "
                        "has failed with following error message.\n\n");
        message += QString::fromStdString(std::string(ex.what()));
        jobItem->setComments(message);
        jobItem->setProgress(100);
        jobItem->setStatus(JobStatus::Failed);
        emit focusRequest(jobItem);
        return;
    }
 
    auto* worker = new JobWorker(identifier, m_simulations[identifier]);
    m_workers[identifier] = worker;
 
    auto* thread = new QThread;
    worker->moveToThread(thread);
    m_threads[identifier] = thread;
 
    // thread will start the worker
    connect(thread, &QThread::started, worker, &JobWorker::start);
 
    // finished thread will be removed from the list
    connect(thread, &QThread::finished, this, &JobQueueData::onFinishedThread);
 
    // connecting the worker to started/progress slots
    connect(worker, &JobWorker::started, this, &JobQueueData::onStartedJob);
    connect(worker, &JobWorker::progressUpdate, this, &JobQueueData::onProgressUpdate);
 
    // finished job will do all cleanup
    connect(worker, &JobWorker::finished, this, &JobQueueData::onFinishedJob);
 
    thread->start();
}

References Error, Failed, JobWorker::finished(), focusRequest(), JobItem::getIdentifier(), getSimulation(), getThread(), JobItem::instrumentItem(), GUI::Transform::ToCore::itemsToSimulation(), m_simulations, m_threads, m_workers, onFinishedJob(), onFinishedThread(), onProgressUpdate(), onStartedJob(), JobWorker::progressUpdate(), JobItem::sampleItem(), JobItem::setComments(), JobItem::setProgress(), JobItem::setStatus(), JobItem::simulationOptionsItem(), JobWorker::start(), and JobWorker::started().

Referenced by JobModel::runJob().

Here is the call graph for this function:

updateGlobalProgress()

void JobQueueData::updateGlobalProgress ( )

private

Estimates global progress from the progress of multiple running jobs and emits appropriate signal.

Definition at line 154 of file JobQueueData.cpp.

{
    int global_progress(0);
    int nRunningJobs(0);
    for (auto* jobItem : m_jobModel->jobItems())
        if (jobItem->isRunning()) {
            global_progress += jobItem->getProgress();
            nRunningJobs++;
        }
 
    if (nRunningJobs)
        global_progress /= nRunningJobs;
    else
        global_progress = -1;
 
    emit globalProgress(global_progress);
}

References globalProgress(), JobModel::jobItems(), and m_jobModel.

Referenced by onProgressUpdate().

Here is the call graph for this function:

Member Data Documentation

m_jobModel

JobModel* JobQueueData::m_jobModel

private

job identifier to simulation

Definition at line 67 of file JobQueueData.h.

Referenced by onFinishedJob(), onProgressUpdate(), onStartedJob(), and updateGlobalProgress().

m_simulations

QMap<QString, ISimulation*> JobQueueData::m_simulations

private

job identifier to jobWorker

Definition at line 65 of file JobQueueData.h.

Referenced by clearSimulation(), getSimulation(), hasUnfinishedJobs(), and runJob().

m_threads

QMap<QString, QThread*> JobQueueData::m_threads

private

Definition at line 63 of file JobQueueData.h.

Referenced by assignForDeletion(), getThread(), onCancelAllJobs(), and runJob().

m_workers

QMap<QString, JobWorker*> JobQueueData::m_workers

private

job identifier to the thread

Definition at line 64 of file JobQueueData.h.

Referenced by assignForDeletion(), getWorker(), and runJob().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Model/JobQueueData.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Model/JobQueueData.cpp