Marble::AbstractWorkerThread Class Reference

#include <AbstractWorkerThread.h>

Inheritance diagram for Marble::AbstractWorkerThread:

Public Member Functions
	AbstractWorkerThread (QObject *parent=nullptr)
void	ensureRunning ()
Public Member Functions inherited from QThread
	QThread (QObject *parent)
virtual bool	event (QEvent *event) override
QAbstractEventDispatcher *	eventDispatcher () const const
void	exit (int returnCode)
void	finished ()
bool	isFinished () const const
bool	isInterruptionRequested () const const
bool	isRunning () const const
int	loopLevel () const const
Priority	priority () const const
void	quit ()
void	requestInterruption ()
void	setEventDispatcher (QAbstractEventDispatcher *eventDispatcher)
void	setPriority (Priority priority)
void	setStackSize (uint stackSize)
uint	stackSize () const const
void	start (Priority priority)
void	started ()
void	terminate ()
bool	wait (QDeadlineTimer deadline)
bool	wait (unsigned long time)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
void	run () override
virtual void	work ()=0
virtual bool	workAvailable ()=0
Protected Member Functions inherited from QThread
int	exec ()
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QThread
enum	Priority
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QThread
QThread *	create (Function &&f, Args &&... args)
QThread *	currentThread ()
Qt::HANDLE	currentThreadId ()
int	idealThreadCount ()
void	msleep (unsigned long msecs)
void	sleep (std::chrono::nanoseconds nsecs)
void	sleep (unsigned long secs)
void	usleep (unsigned long usecs)
void	yieldCurrentThread ()
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QThread
	HighestPriority
	HighPriority
	IdlePriority
	InheritPriority
	LowestPriority
	LowPriority
	NormalPriority
	TimeCriticalPriority
Public Attributes inherited from QObject
typedef	QObjectList
Static Protected Member Functions inherited from QThread
void	setTerminationEnabled (bool enabled)

Detailed Description

The AbstractWorkerThread is a class written for small tasks that have to run multiple times on different data asynchronously.

You should be able to use this class for many different tasks, but you'll have to think about Multi-Threading additionally. The AbstractWorkerThread runs the function work() as long as workAvailable() returns true. If there is no work available for a longer time, the thread will switch itself off. As a result you have to call ensureRunning() every time you want something to be worked on. You'll probably want to call this in your addSchedule() function.

Definition at line 31 of file AbstractWorkerThread.h.

Constructor & Destructor Documentation

AbstractWorkerThread()

Marble::AbstractWorkerThread::AbstractWorkerThread ( QObject * parent = nullptr )

explicit

Definition at line 42 of file AbstractWorkerThread.cpp.

~AbstractWorkerThread()

Marble::AbstractWorkerThread::~AbstractWorkerThread ( )

override

Definition at line 48 of file AbstractWorkerThread.cpp.

Member Function Documentation

ensureRunning()

void Marble::AbstractWorkerThread::ensureRunning

(

)

Definition at line 53 of file AbstractWorkerThread.cpp.

run()

void Marble::AbstractWorkerThread::run ( )

overrideprotectedvirtual

Reimplemented from QThread.

Definition at line 64 of file AbstractWorkerThread.cpp.

---

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

• AbstractWorkerThread.h
• AbstractWorkerThread.cpp