QFutureInterface< T > Class Template Reference

#include <qfutureinterface.h>

Inheritance diagram for QFutureInterface< T >:

Public Functions
QFuture< T >	future ()
QFutureInterface &	operator= (const QFutureInterface &other)
	QFutureInterface (State initialState=NoState)
	QFutureInterface (const QFutureInterface &other)
void	reportFinished (const T *result=0)
void	reportResult (const T *result, int index=-1)
void	reportResult (const T &result, int index=-1)
void	reportResults (const QVector< T > &results, int beginIndex=-1, int count=-1)
const T *	resultPointer (int index) const
const T &	resultReference (int index) const
QList< T >	results ()
	~QFutureInterface ()
Public Functions inherited from QFutureInterfaceBase
void	cancel ()
QtConcurrent::internal::ExceptionStore &	exceptionStore ()
int	expectedResultCount ()
bool	isCanceled () const
bool	isFinished () const
bool	isPaused () const
bool	isProgressUpdateNeeded () const
bool	isResultReadyAt (int index) const
bool	isRunning () const
bool	isStarted () const
bool	isThrottled () const
QMutex *	mutex () const
bool	operator!= (const QFutureInterfaceBase &other) const
QFutureInterfaceBase &	operator= (const QFutureInterfaceBase &other)
bool	operator== (const QFutureInterfaceBase &other) const
int	progressMaximum () const
int	progressMinimum () const
QString	progressText () const
int	progressValue () const
	QFutureInterfaceBase (State initialState=NoState)
	QFutureInterfaceBase (const QFutureInterfaceBase &other)
bool	queryState (State state) const
void	reportCanceled ()
void	reportException (const QtConcurrent::Exception &e)
void	reportFinished ()
void	reportResultsReady (int beginIndex, int endIndex)
void	reportStarted ()
int	resultCount () const
QtConcurrent::ResultStoreBase &	resultStoreBase ()
const QtConcurrent::ResultStoreBase &	resultStoreBase () const
void	setExpectedResultCount (int resultCount)
void	setFilterMode (bool enable)
void	setPaused (bool paused)
void	setProgressRange (int minimum, int maximum)
void	setProgressValue (int progressValue)
void	setProgressValueAndText (int progressValue, const QString &progressText)
void	setRunnable (QRunnable *runnable)
void	setThrottled (bool enable)
void	togglePaused ()
void	waitForFinished ()
bool	waitForNextResult ()
void	waitForResult (int resultIndex)
void	waitForResume ()
virtual	~QFutureInterfaceBase ()

Static Public Functions
static QFutureInterface	canceledResult ()

Private Functions
QtConcurrent::ResultStore< T > &	resultStore ()
const QtConcurrent::ResultStore< T > &	resultStore () const

Additional Inherited Members
Public Types inherited from QFutureInterfaceBase
enum	State {   NoState = 0x00, Running = 0x01, Started = 0x02, Finished = 0x04,   Canceled = 0x08, Paused = 0x10, Throttled = 0x20 }
Protected Functions inherited from QFutureInterfaceBase
bool	referenceCountIsOne () const

Detailed Description

template<typename T>
class QFutureInterface< T >

Definition at line 148 of file qfutureinterface.h.

Constructors and Destructors

QFutureInterface() [1/2]

template<typename T>

QFutureInterface< T >::QFutureInterface ( State  initialState = NoState )

inline

Definition at line 151 of file qfutureinterface.h.

        : QFutureInterfaceBase(initialState)
    { }

QFutureInterface() [2/2]

template<typename T>

QFutureInterface< T >::QFutureInterface ( const QFutureInterface< T > &  other )

inline

Definition at line 154 of file qfutureinterface.h.

        : QFutureInterfaceBase(other)
    { }

~QFutureInterface()

template<typename T>

QFutureInterface< T >::~QFutureInterface ( )

inline

Definition at line 157 of file qfutureinterface.h.

    {
        if (referenceCountIsOne())
            resultStore().clear();
    }

Functions

canceledResult()

template<typename T>

static QFutureInterface QFutureInterface< T >::canceledResult ( )

inlinestatic

Definition at line 163 of file qfutureinterface.h.

    { return QFutureInterface(State(Started | Finished | Canceled)); }

future()

template<typename T >

QFuture< T > QFutureInterface< T >::future ( )

inline

Definition at line 186 of file qfuture.h.

{
    return QFuture<T>(this);
}

operator=()

template<typename T>

QFutureInterface& QFutureInterface< T >::operator= ( const QFutureInterface< T > &  other )

inline

Definition at line 166 of file qfutureinterface.h.

    {
        if (referenceCountIsOne())
            resultStore().clear();
        QFutureInterfaceBase::operator=(other);
        return *this;
    }

reportFinished()

template<typename T >

void QFutureInterface< T >::reportFinished ( const T *  result = 0 )

inline

Definition at line 239 of file qfutureinterface.h.

{
    if (result)
        reportResult(result);
    QFutureInterfaceBase::reportFinished();
}

reportResult() [1/2]

template<typename T >

void QFutureInterface< T >::reportResult ( const T *  result, int  index = -1  )

inline

Definition at line 192 of file qfutureinterface.h.

{
    QMutexLocker locker(mutex());
    if (this->queryState(Canceled) || this->queryState(Finished)) {
        return;
    }

    QtConcurrent::ResultStore<T> &store = resultStore();


    if (store.filterMode()) {
        const int resultCountBefore = store.count();
        store.addResult(index, result);
        this->reportResultsReady(resultCountBefore, resultCountBefore + store.count());
    } else {
        const int insertIndex = store.addResult(index, result);
        this->reportResultsReady(insertIndex, insertIndex + 1);
    }
}

reportResult() [2/2]

template<typename T >

void QFutureInterface< T >::reportResult ( const T &  result, int  index = -1  )

inline

Definition at line 213 of file qfutureinterface.h.

{
    reportResult(&result, index);
}

reportResults()

template<typename T >

void QFutureInterface< T >::reportResults ( const QVector< T > &  results, int  beginIndex = -1, int  count = -1  )

inline

Definition at line 219 of file qfutureinterface.h.

{
    QMutexLocker locker(mutex());
    if (this->queryState(Canceled) || this->queryState(Finished)) {
        return;
    }

    QtConcurrent::ResultStore<T> &store = resultStore();

    if (store.filterMode()) {
        const int resultCountBefore = store.count();
        store.addResults(beginIndex, &_results, count);
        this->reportResultsReady(resultCountBefore, store.count());
    } else {
        const int insertIndex = store.addResults(beginIndex, &_results, count);
        this->reportResultsReady(insertIndex, insertIndex + _results.count());    
    }
}

resultPointer()

template<typename T >

const T * QFutureInterface< T >::resultPointer ( int  index ) const

inline

Definition at line 254 of file qfutureinterface.h.

{
    QMutexLocker lock(mutex());
    return resultStore().resultAt(index).pointer();
}

resultReference()

template<typename T >

const T & QFutureInterface< T >::resultReference ( int  index ) const

inline

Definition at line 247 of file qfutureinterface.h.

{
    QMutexLocker lock(mutex());
    return resultStore().resultAt(index).value();
}

results()

template<typename T >

QList< T > QFutureInterface< T >::results ( )

inline

Definition at line 261 of file qfutureinterface.h.

{
    if (this->isCanceled()) {
        exceptionStore().throwPossibleException();
        return QList<T>();
    }
    QFutureInterfaceBase::waitForResult(-1);

    QList<T> res;
    QMutexLocker lock(mutex());

    QtConcurrent::ResultIterator<T> it = resultStore().begin();
    while (it != resultStore().end()) {
        res.append(it.value());
        ++it;
    }

    return res;
}

resultStore() [1/2]

template<typename T>

QtConcurrent::ResultStore<T>& QFutureInterface< T >::resultStore ( )

inlineprivate

Definition at line 185 of file qfutureinterface.h.

    { return static_cast<QtConcurrent::ResultStore<T> &>(resultStoreBase()); }

resultStore() [2/2]

template<typename T>

const QtConcurrent::ResultStore<T>& QFutureInterface< T >::resultStore ( ) const

inlineprivate

Definition at line 187 of file qfutureinterface.h.

    { return static_cast<const QtConcurrent::ResultStore<T> &>(resultStoreBase()); }

---

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

• /src/corelib/concurrent/qfutureinterface.h
• /src/corelib/concurrent/qfuture.h