digiKam
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
Digikam::WorkerObject Class Reference
+ Inheritance diagram for Digikam::WorkerObject:

Public Types

enum  DeactivatingMode { FlushSignals , KeepSignals , PhaseOut }
 
enum  State { Inactive , Scheduled , Running , Deactivating }
 

Public Slots

void deactivate (DeactivatingMode mode=FlushSignals)
 
void schedule ()
 

Signals

void finished ()
 
void started ()
 

Public Member Functions

bool connectAndSchedule (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type=Qt::AutoConnection) const
 
QThread::Priority priority () const
 
void setPriority (QThread::Priority priority)
 
State state () const
 
void wait ()
 
 WorkerObject ()
 
 ~WorkerObject () override
 

Static Public Member Functions

static bool connectAndSchedule (const QObject *sender, const char *signal, const WorkerObject *receiver, const char *method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnectAndSchedule (const QObject *sender, const char *signal, const WorkerObject *receiver, const char *method)
 

Protected Member Functions

virtual void aboutToDeactivate ()
 
virtual void aboutToQuitLoop ()
 
void addRunnable (WorkerObjectRunnable *loop)
 
bool event (QEvent *e) override
 
void removeRunnable (WorkerObjectRunnable *loop)
 
void run ()
 
void setEventLoop (QEventLoop *loop)
 
void shutDown ()
 
void transitionToInactive ()
 
bool transitionToRunning ()
 

Friends

class ThreadManager
 
class WorkerObjectRunnable
 

Member Enumeration Documentation

◆ DeactivatingMode

enum Digikam::WorkerObject::DeactivatingMode
Enumerator
FlushSignals 

Already sent signals are cleared.

KeepSignals 

The thread is stopped, but already sent signals remain in the queue.

PhaseOut 

The thread is stopped when all signals emitted until now have been processed.

◆ State

enum Digikam::WorkerObject::State
Enumerator
Inactive 
Scheduled 
Running 
Deactivating 

Constructor & Destructor Documentation

◆ WorkerObject()

Digikam::WorkerObject::WorkerObject ( )
explicit

Deriving from a worker object allows you to execute your slots in a thread. Implement any slots and connect signals just as usual. Call schedule() before or when signals are emitted. The object will have moved to a thread when the signals are received by the slots. Call deactivate() to stop computation. Note that without calling schedule(), no signal will ever be processed. You can use the connectAndSchedule convenience connection to avoid having to call schedule() directly. Note that you cannot make this QObject the child of another QObject. Please check if you need to call shutDown from your destructor (see below).

References Digikam::ThreadManager::initialize(), and Digikam::ThreadManager::instance().

◆ ~WorkerObject()

Digikam::WorkerObject::~WorkerObject ( )
override

References shutDown().

Member Function Documentation

◆ aboutToDeactivate()

void Digikam::WorkerObject::aboutToDeactivate ( )
protectedvirtual

Called from deactivate(), typically from a different thread than the worker thread, possibly the UI thread. You can stop any extra controlled threads here. Immediately afterwards, an event will be sent to the working thread which will cause the event loop to quit. (aboutToQuitLoop())

Reimplemented in Digikam::TrainerWorker, and Digikam::RecognitionWorker.

Referenced by deactivate().

◆ aboutToQuitLoop()

void Digikam::WorkerObject::aboutToQuitLoop ( )
protectedvirtual

Called from within thread's event loop to quit processing. Quit any blocking operation. Immediately afterwards, the event loop will be quit.

Referenced by event().

◆ addRunnable()

void Digikam::WorkerObject::addRunnable ( WorkerObjectRunnable *  loop)
protected

◆ connectAndSchedule() [1/2]

bool Digikam::WorkerObject::connectAndSchedule ( const QObject *  sender,
const char *  signal,
const char *  method,
Qt::ConnectionType  type = Qt::AutoConnection 
) const

You must normally call schedule() to ensure that the object is active when you send a signal with work data. Instead, you can use these connect() methods when connecting your signal to this object, the signal that carries work data. Then the object will be scheduled each time you emit the signal.

References schedule().

Referenced by Digikam::FileActionMngr::Private::connectToDatabaseWorker().

◆ connectAndSchedule() [2/2]

bool Digikam::WorkerObject::connectAndSchedule ( const QObject *  sender,
const char *  signal,
const WorkerObject *  receiver,
const char *  method,
Qt::ConnectionType  type = Qt::AutoConnection 
)
static

References schedule().

◆ deactivate

void Digikam::WorkerObject::deactivate ( DeactivatingMode  mode = FlushSignals)
slot

Quits execution of this worker object. If mode is FlushSignals, all already emitted signals will be cleared. If mode is KeepSignals, already emitted signals are not cleared and will be kept in the event queue until destruction or schedule() is called. If mode is PhaseOut, already emitted signals will be processed and the thread quit immediately afterwards.

References aboutToDeactivate(), Deactivating, FlushSignals, Inactive, KeepSignals, Running, and Scheduled.

Referenced by Digikam::FileActionMngr::shutDown(), shutDown(), and Digikam::FacePipeline::Private::stop().

◆ disconnectAndSchedule()

bool Digikam::WorkerObject::disconnectAndSchedule ( const QObject *  sender,
const char *  signal,
const WorkerObject *  receiver,
const char *  method 
)
static

References schedule().

◆ event()

bool Digikam::WorkerObject::event ( QEvent *  e)
overrideprotected

References aboutToQuitLoop().

◆ finished

void Digikam::WorkerObject::finished ( )
signal

◆ priority()

QThread::Priority Digikam::WorkerObject::priority ( ) const

Referenced by setPriority().

◆ removeRunnable()

void Digikam::WorkerObject::removeRunnable ( WorkerObjectRunnable *  loop)
protected

◆ run()

void Digikam::WorkerObject::run ( )
protected

◆ schedule

void Digikam::WorkerObject::schedule ( )
slot

Starts execution of this worker object: The object is moved to a thread and an event loop started, so that queued signals will be received.

References Deactivating, Inactive, Digikam::ThreadManager::instance(), Running, Digikam::ThreadManager::schedule(), and Scheduled.

Referenced by connectAndSchedule(), disconnectAndSchedule(), Digikam::ParallelWorkers::replacementStaticQtMetacall(), and Digikam::FacePipeline::Private::start().

◆ setEventLoop()

void Digikam::WorkerObject::setEventLoop ( QEventLoop *  loop)
protected

◆ setPriority()

void Digikam::WorkerObject::setPriority ( QThread::Priority  priority)

Sets the priority for this dynamic thread. Can be set anytime. If the thread is currently not running, the priority will be set when it is run next time. When you set QThread::InheritPriority (default), the priority is not changed but inherited from the thread pool.

References priority(), and Running.

Referenced by Digikam::FacePipeline::Private::applyPriority().

◆ shutDown()

void Digikam::WorkerObject::shutDown ( )
protected

If you are deleting data in your destructor which is accessed from the thread, do one of the following from your destructor to guarantee a safe shutdown: 1) Call this method 2) Call stop() and wait(), knowing that nothing will call start() anymore after this 3) Be sure the thread will never be running at destruction. Note: This irrevocably stops this object. Note: It is not sufficient that your parent class does this. Calling this method, or providing one of the above mentioned equivalent guarantees, must be done by every single last class in the hierarchy with an implemented destructor deleting data. (the base class destructor is always called after the derived class)

References deactivate(), PhaseOut, and wait().

Referenced by ~WorkerObject().

◆ started

void Digikam::WorkerObject::started ( )
signal

◆ state()

WorkerObject::State Digikam::WorkerObject::state ( ) const

Referenced by Digikam::FileActionMngrDatabaseWorker::applyMetadata(), Digikam::FileActionMngrDatabaseWorker::assignColorLabel(), Digikam::FileActionMngrDatabaseWorker::assignPickLabel(), Digikam::FileActionMngrDatabaseWorker::assignRating(), Digikam::FileActionMngrDatabaseWorker::copyAttributes(), Digikam::FileActionMngrDatabaseWorker::editGroup(), Digikam::FileActionMngrDatabaseWorker::setExifOrientation(), Digikam::FileActionMngrFileWorker::transform(), Digikam::FileActionMngrFileWorker::writeMetadata(), Digikam::FileActionMngrFileWorker::writeMetadataToFiles(), and Digikam::FileActionMngrFileWorker::writeOrientationToFiles().

◆ transitionToInactive()

void Digikam::WorkerObject::transitionToInactive ( )
protected

References Deactivating, Inactive, and Scheduled.

◆ transitionToRunning()

bool Digikam::WorkerObject::transitionToRunning ( )
protected

References Deactivating, Running, and Scheduled.

◆ wait()

void Digikam::WorkerObject::wait ( )

References Inactive.

Referenced by Digikam::FileActionMngr::shutDown(), shutDown(), Digikam::FacePipeline::Private::wait(), Digikam::DetectionWorker::~DetectionWorker(), Digikam::RecognitionWorker::~RecognitionWorker(), and Digikam::TrainerWorker::~TrainerWorker().

Friends And Related Function Documentation

◆ ThreadManager

friend class ThreadManager
friend

◆ WorkerObjectRunnable

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