Marble::AbstractWorkerThread Class Reference

#include <AbstractWorkerThread.h>

Inheritance diagram for Marble::AbstractWorkerThread:

Public Member Functions
	AbstractWorkerThread (QObject *parent=0)
virtual	~AbstractWorkerThread ()
void	ensureRunning ()
Public Member Functions inherited from QThread
	QThread (QObject *parent)
	~QThread ()
void	exit (int returnCode)
bool	finished () const
void	finished ()
bool	isFinished () const
bool	isRunning () const
Priority	priority () const
void	quit ()
bool	running () const
void	setPriority (Priority priority)
void	setStackSize (uint stackSize)
uint	stackSize () const
void	start (Priority priority)
void	started ()
void	terminate ()
void	terminated ()
bool	wait (unsigned long time)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

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

Additional Inherited Members
Static Public Member Functions inherited from QThread
QThread *	currentThread ()
Qt::HANDLE	currentThreadId ()
int	idealThreadCount ()
void	yieldCurrentThread ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QThread
void	msleep (unsigned long msecs)
void	setTerminationEnabled (bool enabled)
void	sleep (unsigned long secs)
void	usleep (unsigned long usecs)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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 36 of file AbstractWorkerThread.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 48 of file AbstractWorkerThread.cpp.

Marble::AbstractWorkerThread::~AbstractWorkerThread ( )

virtual

Definition at line 54 of file AbstractWorkerThread.cpp.

Member Function Documentation

void Marble::AbstractWorkerThread::ensureRunning

(

)

Definition at line 59 of file AbstractWorkerThread.cpp.

void Marble::AbstractWorkerThread::run ( )

protectedvirtual

Reimplemented from QThread.

Definition at line 70 of file AbstractWorkerThread.cpp.

virtual void Marble::AbstractWorkerThread::work ( )

protectedpure virtual

Implemented in Marble::BBCParser, and Marble::BBCItemGetter.

virtual bool Marble::AbstractWorkerThread::workAvailable ( )

protectedpure virtual

Implemented in Marble::BBCParser, and Marble::BBCItemGetter.

---

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

• AbstractWorkerThread.h
• AbstractWorkerThread.cpp