digiKam
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Digikam::ParallelAdapter< A > Class Template Reference
+ Inheritance diagram for Digikam::ParallelAdapter< A >:

Public Member Functions

void add (A *const worker)
 
QObject * asQObject () override
 
bool connect (const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type=Qt::AutoConnection) const
 
void deactivate (WorkerObject::DeactivatingMode mode=WorkerObject::FlushSignals)
 
const QMetaObject * metaObject () const override
 
const QMetaObject * mocMetaObject () const override
 
bool optimalWorkerCountReached () const
 
 ParallelAdapter ()
 
int qt_metacall (QMetaObject::Call _c, int _id, void **_a) override
 
void schedule ()
 
void setPriority (QThread::Priority priority)
 
StaticMetacallFunction staticMetacallPointer () override
 
void wait ()
 
int WorkerObjectQtMetacall (QMetaObject::Call _c, int _id, void **_a) override
 
 ~ParallelAdapter () override
 

Static Public Member Functions

static int optimalWorkerCount ()
 
static void qt_static_metacall (QObject *o, QMetaObject::Call _c, int _id, void **_a)
 

Protected Types

typedef void(* StaticMetacallFunction) (QObject *, QMetaObject::Call, int, void **)
 

Protected Member Functions

void add (WorkerObject *const worker)
 
const QMetaObject * replacementMetaObject () const
 
int replacementQtMetacall (QMetaObject::Call _c, int _id, void **_a)
 
int replacementStaticQtMetacall (QMetaObject::Call _c, int _id, void **_a)
 

Protected Attributes

int m_currentIndex
 
StaticMetacallFunction m_originalStaticMetacall
 
QMetaObject * m_replacementMetaObject
 
QList< WorkerObject * > m_workers
 

Member Typedef Documentation

◆ StaticMetacallFunction

typedef void(* Digikam::ParallelWorkers::StaticMetacallFunction) (QObject *, QMetaObject::Call, int, void **)
protectedinherited

Constructor & Destructor Documentation

◆ ParallelAdapter()

template<class A >
Digikam::ParallelAdapter< A >::ParallelAdapter ( )
inlineexplicit

Instead of using a single WorkerObject, create a ParallelAdapter for your worker object subclass, and add() individual WorkerObjects. The load will be evenly distributed. Note: unlike with WorkerObject directly, there is no need to call schedule(). For inbound connections (signals connected to a WorkerObject's slot, to be processed, use a Qt::DirectConnection on the adapter. For outbound connections (signals emitted from the WorkerObject), use ParallelAdapter's connect to have a connection from all added WorkerObjects.

◆ ~ParallelAdapter()

template<class A >
Digikam::ParallelAdapter< A >::~ParallelAdapter ( )
inlineoverride

Member Function Documentation

◆ add() [1/2]

template<class A >
void Digikam::ParallelAdapter< A >::add ( A *const  worker)
inline

References Digikam::ParallelWorkers::add().

◆ add() [2/2]

void Digikam::ParallelWorkers::add ( WorkerObject *const  worker)
protectedinherited

References Digikam::ParallelWorkers::m_workers.

Referenced by Digikam::ParallelAdapter< A >::add().

◆ asQObject()

template<class A >
QObject* Digikam::ParallelAdapter< A >::asQObject ( )
inlineoverridevirtual

Return the target QObject (double inheritance)

Implements Digikam::ParallelWorkers.

◆ connect()

template<class A >
bool Digikam::ParallelAdapter< A >::connect ( const char *  signal,
const QObject *  receiver,
const char *  method,
Qt::ConnectionType  type = Qt::AutoConnection 
) const
inline

References Digikam::ParallelWorkers::connect().

◆ deactivate()

template<class A >
void Digikam::ParallelAdapter< A >::deactivate ( WorkerObject::DeactivatingMode  mode = WorkerObject::FlushSignals)
inline

References Digikam::ParallelWorkers::deactivate().

◆ metaObject()

template<class A >
const QMetaObject* Digikam::ParallelAdapter< A >::metaObject ( ) const
inlineoverride

References Digikam::ParallelWorkers::replacementMetaObject().

◆ mocMetaObject()

template<class A >
const QMetaObject* Digikam::ParallelAdapter< A >::mocMetaObject ( ) const
inlineoverridevirtual

The moc-generated metaObject of the target object

Implements Digikam::ParallelWorkers.

◆ optimalWorkerCount()

int Digikam::ParallelWorkers::optimalWorkerCount ( )
staticinherited

Regarding the number of logical CPUs on the current machine, returns the optimal count of concurrent workers

Referenced by Digikam::ItemInfoTaskSplitter::ItemInfoTaskSplitter(), and Digikam::ParallelWorkers::optimalWorkerCountReached().

◆ optimalWorkerCountReached()

bool Digikam::ParallelWorkers::optimalWorkerCountReached ( ) const
inherited

Returns true if the current number of added workers has reached the optimalWorkerCount()

References Digikam::ParallelWorkers::m_workers, and Digikam::ParallelWorkers::optimalWorkerCount().

◆ qt_metacall()

template<class A >
int Digikam::ParallelAdapter< A >::qt_metacall ( QMetaObject::Call  _c,
int  _id,
void **  _a 
)
inlineoverride

References Digikam::ParallelWorkers::replacementQtMetacall().

◆ qt_static_metacall()

template<class A >
static void Digikam::ParallelAdapter< A >::qt_static_metacall ( QObject *  o,
QMetaObject::Call  _c,
int  _id,
void **  _a 
)
inlinestatic

References Digikam::ParallelWorkers::replacementStaticQtMetacall().

Referenced by Digikam::ParallelAdapter< A >::staticMetacallPointer().

◆ replacementMetaObject()

const QMetaObject * Digikam::ParallelWorkers::replacementMetaObject ( ) const
protectedinherited

References Digikam::ParallelWorkers::m_originalStaticMetacall, Digikam::ParallelWorkers::m_replacementMetaObject, Digikam::ParallelWorkers::mocMetaObject(), and Digikam::ParallelWorkers::staticMetacallPointer().

Referenced by Digikam::ParallelAdapter< A >::metaObject().

◆ replacementQtMetacall()

int Digikam::ParallelWorkers::replacementQtMetacall ( QMetaObject::Call  _c,
int  _id,
void **  _a 
)
protectedinherited

Replaces slot call distribution of the target QObject

References Digikam::ParallelWorkers::replacementStaticQtMetacall(), and Digikam::ParallelWorkers::WorkerObjectQtMetacall().

Referenced by Digikam::ParallelAdapter< A >::qt_metacall().

◆ replacementStaticQtMetacall()

int Digikam::ParallelWorkers::replacementStaticQtMetacall ( QMetaObject::Call  _c,
int  _id,
void **  _a 
)
protectedinherited

References Digikam::ParallelWorkers::asQObject(), Digikam::ParallelWorkers::m_currentIndex, Digikam::ParallelWorkers::m_originalStaticMetacall, Digikam::ParallelWorkers::m_workers, Digikam::ParallelWorkers::mocMetaObject(), and Digikam::WorkerObject::schedule().

Referenced by Digikam::ParallelAdapter< A >::qt_static_metacall(), and Digikam::ParallelWorkers::replacementQtMetacall().

◆ schedule()

template<class A >
void Digikam::ParallelAdapter< A >::schedule ( )
inline

References Digikam::ParallelWorkers::schedule().

◆ setPriority()

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

References Digikam::ParallelWorkers::m_workers.

◆ staticMetacallPointer()

template<class A >
StaticMetacallFunction Digikam::ParallelAdapter< A >::staticMetacallPointer ( )
inlineoverridevirtual

Implements Digikam::ParallelWorkers.

References Digikam::ParallelAdapter< A >::qt_static_metacall().

◆ wait()

template<class A >
void Digikam::ParallelAdapter< A >::wait ( )
inline

References Digikam::ParallelWorkers::wait().

◆ WorkerObjectQtMetacall()

template<class A >
int Digikam::ParallelAdapter< A >::WorkerObjectQtMetacall ( QMetaObject::Call  _c,
int  _id,
void **  _a 
)
inlineoverridevirtual

The qt_metacall of WorkerObject, one level above the target QObject

Implements Digikam::ParallelWorkers.

Member Data Documentation

◆ m_currentIndex

int Digikam::ParallelWorkers::m_currentIndex
protectedinherited

Referenced by Digikam::ParallelWorkers::replacementStaticQtMetacall().

◆ m_originalStaticMetacall

StaticMetacallFunction Digikam::ParallelWorkers::m_originalStaticMetacall
protectedinherited

Referenced by Digikam::ParallelWorkers::replacementMetaObject(), and Digikam::ParallelWorkers::replacementStaticQtMetacall().

◆ m_replacementMetaObject

QMetaObject* Digikam::ParallelWorkers::m_replacementMetaObject
protectedinherited

Referenced by Digikam::ParallelWorkers::replacementMetaObject(), and Digikam::ParallelWorkers::~ParallelWorkers().

◆ m_workers

QList<WorkerObject*> Digikam::ParallelWorkers::m_workers
protectedinherited

Referenced by Digikam::ParallelWorkers::add(), Digikam::ParallelWorkers::connect(), Digikam::ParallelWorkers::deactivate(), Digikam::ParallelWorkers::optimalWorkerCountReached(), Digikam::ParallelWorkers::replacementStaticQtMetacall(), Digikam::ParallelWorkers::schedule(), Digikam::ParallelWorkers::setPriority(), Digikam::ParallelWorkers::wait(), and Digikam::ParallelWorkers::~ParallelWorkers().

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