Skip to content

shapeworks::Job

Inherits from QObject

Inherited by shapeworks::DeepSSMJob, shapeworks::GroupPvalueJob, shapeworks::NetworkAnalysisJob, shapeworks::ParticleAreaJob, shapeworks::ParticleNormalEvaluationJob, shapeworks::ShapeEvaluationJob, shapeworks::ShapeScalarJob, shapeworks::StatsGroupLDAJob

Public Signals

Name
void progress(double , QString ="")
void finished()

Public Functions

Name
Job()
virtual ~Job()
virtual void run() =0
run the job
virtual QString name() =0
get the name of the job
virtual QString get_completion_message()
get a message to display when the job is complete
virtual QString get_abort_message()
get a message to display when the job is aborted
void start_timer()
start the timer
qint64 timer_elapsed()
how much time has elapsed since the timer was started
void set_complete(bool complete)
set the job as complete
bool is_complete() const
is the job complete?
void abort()
abort the job
bool is_aborted() const
was the job aborted?
void set_quiet_mode(bool quiet)
set to quiet mode (no progress messages)
bool get_quiet_mode()
get quiet mode

Public Signals Documentation

signal progress

void progress(
    double ,
    QString  =""
)

signal finished

void finished()

Public Functions Documentation

function Job

Job()

function ~Job

virtual ~Job()

function run

virtual void run() =0

run the job

Reimplemented by: shapeworks::ShapeEvaluationJob::run, shapeworks::DeepSSMJob::run, shapeworks::GroupPvalueJob::run, shapeworks::NetworkAnalysisJob::run, shapeworks::ParticleAreaJob::run, shapeworks::ParticleNormalEvaluationJob::run, shapeworks::ShapeScalarJob::run, shapeworks::StatsGroupLDAJob::run

function name

virtual QString name() =0

get the name of the job

Reimplemented by: shapeworks::ShapeEvaluationJob::name, shapeworks::DeepSSMJob::name, shapeworks::GroupPvalueJob::name, shapeworks::NetworkAnalysisJob::name, shapeworks::ParticleAreaJob::name, shapeworks::ParticleNormalEvaluationJob::name, shapeworks::ShapeScalarJob::name, shapeworks::StatsGroupLDAJob::name

function get_completion_message

virtual QString get_completion_message()

get a message to display when the job is complete

function get_abort_message

virtual QString get_abort_message()

get a message to display when the job is aborted

function start_timer

void start_timer()

start the timer

function timer_elapsed

qint64 timer_elapsed()

how much time has elapsed since the timer was started

function set_complete

inline void set_complete(
    bool complete
)

set the job as complete

function is_complete

inline bool is_complete() const

is the job complete?

function abort

inline void abort()

abort the job

function is_aborted

inline bool is_aborted() const

was the job aborted?

function set_quiet_mode

inline void set_quiet_mode(
    bool quiet
)

set to quiet mode (no progress messages)

function get_quiet_mode

inline bool get_quiet_mode()

get quiet mode


Updated on 2024-07-14 at 17:07:24 +0000