digiKam
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Digikam::ItemFilterModelWorker Class Referenceabstract
+ Inheritance diagram for Digikam::ItemFilterModelWorker:

Public Types

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

Public Slots

void deactivate (DeactivatingMode mode=FlushSignals)
 
virtual void process (ItemFilterModelTodoPackage package)=0
 
void schedule ()
 

Signals

void discarded (const ItemFilterModelTodoPackage &package)
 
void finished ()
 
void processed (const ItemFilterModelTodoPackage &package)
 
void started ()
 

Public Member Functions

bool checkVersion (const ItemFilterModelTodoPackage &package)
 
bool connectAndSchedule (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type=Qt::AutoConnection) const
 
 ItemFilterModelWorker (ItemFilterModel::ItemFilterModelPrivate *const dd)
 
QThread::Priority priority () const
 
void setPriority (QThread::Priority priority)
 
State state () const
 
void wait ()
 

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 ()
 

Protected Attributes

ItemFilterModel::ItemFilterModelPrivate * d
 

Member Enumeration Documentation

◆ DeactivatingMode

enum Digikam::WorkerObject::DeactivatingMode
inherited
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
inherited
Enumerator
Inactive 
Scheduled 
Running 
Deactivating 

Constructor & Destructor Documentation

◆ ItemFilterModelWorker()

Digikam::ItemFilterModelWorker::ItemFilterModelWorker ( ItemFilterModel::ItemFilterModelPrivate *const  dd)
explicit

Member Function Documentation

◆ aboutToDeactivate()

void Digikam::WorkerObject::aboutToDeactivate ( )
protectedvirtualinherited

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 Digikam::WorkerObject::deactivate().

◆ aboutToQuitLoop()

void Digikam::WorkerObject::aboutToQuitLoop ( )
protectedvirtualinherited

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

Referenced by Digikam::WorkerObject::event().

◆ addRunnable()

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

◆ checkVersion()

bool Digikam::ItemFilterModelWorker::checkVersion ( const ItemFilterModelTodoPackage &  package)

References d, and Digikam::ItemFilterModelTodoPackage::version.

Referenced by Digikam::ItemFilterModelPreparer::process(), and Digikam::ItemFilterModelFilterer::process().

◆ connectAndSchedule() [1/2]

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

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 Digikam::WorkerObject::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 
)
staticinherited

References Digikam::WorkerObject::schedule().

◆ deactivate

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

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 Digikam::WorkerObject::aboutToDeactivate(), Digikam::WorkerObject::Deactivating, Digikam::WorkerObject::FlushSignals, Digikam::WorkerObject::Inactive, Digikam::WorkerObject::KeepSignals, Digikam::WorkerObject::Running, and Digikam::WorkerObject::Scheduled.

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

◆ discarded

void Digikam::ItemFilterModelWorker::discarded ( const ItemFilterModelTodoPackage &  package)
signal

Referenced by Digikam::ItemFilterModelPreparer::process(), and Digikam::ItemFilterModelFilterer::process().

◆ disconnectAndSchedule()

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

References Digikam::WorkerObject::schedule().

◆ event()

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

References Digikam::WorkerObject::aboutToQuitLoop().

◆ finished

void Digikam::WorkerObject::finished ( )
signalinherited

◆ priority()

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

Referenced by Digikam::WorkerObject::setPriority().

◆ process

virtual void Digikam::ItemFilterModelWorker::process ( ItemFilterModelTodoPackage  package)
pure virtualslot

Implemented in Digikam::ItemFilterModelFilterer, and Digikam::ItemFilterModelPreparer.

◆ processed

void Digikam::ItemFilterModelWorker::processed ( const ItemFilterModelTodoPackage &  package)
signal

Referenced by Digikam::ItemFilterModelPreparer::process(), and Digikam::ItemFilterModelFilterer::process().

◆ removeRunnable()

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

◆ run()

void Digikam::WorkerObject::run ( )
protectedinherited

◆ schedule

void Digikam::WorkerObject::schedule ( )
slotinherited

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 Digikam::WorkerObject::Deactivating, Digikam::WorkerObject::Inactive, Digikam::ThreadManager::instance(), Digikam::WorkerObject::Running, Digikam::ThreadManager::schedule(), and Digikam::WorkerObject::Scheduled.

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

◆ setEventLoop()

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

◆ setPriority()

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

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 Digikam::WorkerObject::priority(), and Digikam::WorkerObject::Running.

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

◆ shutDown()

void Digikam::WorkerObject::shutDown ( )
protectedinherited

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 Digikam::WorkerObject::deactivate(), Digikam::WorkerObject::PhaseOut, and Digikam::WorkerObject::wait().

Referenced by Digikam::WorkerObject::~WorkerObject().

◆ started

void Digikam::WorkerObject::started ( )
signalinherited

◆ state()

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

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 ( )
protectedinherited

References Digikam::WorkerObject::Deactivating, Digikam::WorkerObject::Inactive, and Digikam::WorkerObject::Scheduled.

◆ transitionToRunning()

bool Digikam::WorkerObject::transitionToRunning ( )
protectedinherited

References Digikam::WorkerObject::Deactivating, Digikam::WorkerObject::Running, and Digikam::WorkerObject::Scheduled.

◆ wait()

void Digikam::WorkerObject::wait ( )
inherited

References Digikam::WorkerObject::Inactive.

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

Member Data Documentation

◆ d

ItemFilterModel::ItemFilterModelPrivate* Digikam::ItemFilterModelWorker::d
protected

Referenced by checkVersion(), Digikam::ItemFilterModelPreparer::process(), and Digikam::ItemFilterModelFilterer::process().

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