digiKam
Loading...
Searching...
No Matches
Digikam::ActionThread Class Reference

#include <actionthread.h>

+ Inheritance diagram for Digikam::ActionThread:

Signals

void signalCancelActionTask ()
 
void signalFinished (const Digikam::ActionData &ad)
 
void signalQueueProcessed ()
 
void signalStarting (const Digikam::ActionData &ad)
 

Public Member Functions

 ActionThread (QObject *const parent)
 
void cancel ()
 
void cancel (bool isCancel=true)
 
int maximumNumberOfThreads () const
 
void processQueueItems (const QList< AssignedBatchTools > &items)
 
void setDefaultMaximumNumberOfThreads ()
 
void setMaximumNumberOfThreads (int n)
 
void setSettings (const QueueSettings &settings)
 
 ~ActionThread () override
 

Protected Slots

void slotJobFinished ()
 

Protected Member Functions

void appendJobs (const ActionJobCollection &jobs)
 
bool isEmpty () const
 
int pendingCount () const
 
void run () override
 

Constructor & Destructor Documentation

◆ ActionThread()

Digikam::ActionThread::ActionThread ( QObject *const  parent)
explicit

◆ ~ActionThread()

Digikam::ActionThread::~ActionThread ( )
override

References cancel().

Member Function Documentation

◆ appendJobs()

◆ cancel() [1/2]

void Digikam::ActionThread::cancel ( )

◆ cancel() [2/2]

void Digikam::ActionThreadBase::cancel ( bool  isCancel = true)
inherited

◆ isEmpty()

bool Digikam::ActionThreadBase::isEmpty ( ) const
protectedinherited

Return true if list of pending jobs to process is empty.

Referenced by Digikam::ActionThreadBase::slotJobFinished().

◆ maximumNumberOfThreads()

◆ pendingCount()

int Digikam::ActionThreadBase::pendingCount ( ) const
protectedinherited

Return the number of pending jobs to process.

◆ processQueueItems()

◆ run()

void Digikam::ActionThreadBase::run ( )
overrideprotectedinherited

Main thread loop used to process jobs in todo list.

References Digikam::ActionJob::m_timer, and Digikam::ActionThreadBase::slotJobFinished().

◆ setDefaultMaximumNumberOfThreads()

void Digikam::ActionThreadBase::setDefaultMaximumNumberOfThreads ( )
inherited

Reset maximum number of threads used to parallelize collection of job processing to max core detected on computer. This method is called in constructor.

References Digikam::ActionThreadBase::setMaximumNumberOfThreads().

Referenced by Digikam::ActionThreadBase::ActionThreadBase(), setSettings(), and Digikam::MaintenanceThread::setUseMultiCore().

◆ setMaximumNumberOfThreads()

void Digikam::ActionThreadBase::setMaximumNumberOfThreads ( int  n)
inherited

Adjust maximum number of threads used to parallelize collection of job processing.

Referenced by Digikam::ActionThreadBase::setDefaultMaximumNumberOfThreads(), setSettings(), and Digikam::MaintenanceThread::setUseMultiCore().

◆ setSettings()

◆ signalCancelActionTask

void Digikam::ActionThread::signalCancelActionTask ( )
signal

Signal to emit to sub-tasks to cancel processing.

Referenced by cancel(), and processQueueItems().

◆ signalFinished

void Digikam::ActionThread::signalFinished ( const Digikam::ActionData ad)
signal

Emit when an item from a queue have been processed.

Referenced by processQueueItems().

◆ signalQueueProcessed

void Digikam::ActionThread::signalQueueProcessed ( )
signal

Emit when a queue have been fully processed (all items from queue are finished).

◆ signalStarting

void Digikam::ActionThread::signalStarting ( const Digikam::ActionData ad)
signal

Emit when an item from a queue start to be processed.

Referenced by processQueueItems().

◆ slotJobFinished

void Digikam::ActionThreadBase::slotJobFinished ( )
protectedslotinherited

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