OTB  6.7.0
Orfeo Toolbox
Public Slots | Signals | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
mvd::AbstractWorker Class Referenceabstract

#include <mvdAbstractWorker.h>

+ Inheritance diagram for mvd::AbstractWorker:
+ Collaboration diagram for mvd::AbstractWorker:

Public Slots

void Do () throw ()
 

Signals

void Done (QObject *result=NULL)
 
void ExceptionRaised (QString what)
 
void Finished ()
 
void ProgressRangeChanged (int min, int max)
 
void ProgressTextChanged (const QString &text)
 
void ProgressValueChanged (int value)
 

Public Member Functions

QString GetFirstProgressText () const
 
 ~AbstractWorker () override
 

Protected Member Functions

 AbstractWorker (QObject *p=NULL)
 

Private Member Functions

virtual QObject * virtual_Do ()=0
 
virtual QString virtual_GetFirstProgressText () const =0
 

Detailed Description

Abstract worker object used as a base-class for threaded tasks.

Definition at line 77 of file mvdAbstractWorker.h.

Constructor & Destructor Documentation

mvd::AbstractWorker::~AbstractWorker ( )
override

Destructor.

mvd::AbstractWorker::AbstractWorker ( QObject *  p = NULL)
protected

Constructor.

Member Function Documentation

void mvd::AbstractWorker::Do ( )
throw (
)
slot

Call the implemented do job/task routine.

void mvd::AbstractWorker::Done ( QObject *  result = NULL)
signal

Signal emitted when job has correctly been done.

Use this signal to get resulting object when job has been done.

Parameters
resultResulting QObject instance of NULL if none.
void mvd::AbstractWorker::ExceptionRaised ( QString  what)
signal

Signal emitted when an exception has been caught by this worker.

Parameters
void mvd::AbstractWorker::Finished ( )
signal

Signal emitted when task (i.e. thread) has finished correctly or incorrectly.

Use this signal to forward to thead quit() slot when job has finished.

QString mvd::AbstractWorker::GetFirstProgressText ( ) const
inline

Definition at line 227 of file mvdAbstractWorker.h.

References virtual_GetFirstProgressText().

void mvd::AbstractWorker::ProgressRangeChanged ( int  min,
int  max 
)
signal

Signal emitted when progress range has changed.

Parameters
minMinimum progress value.
maxMaximum progress value.
void mvd::AbstractWorker::ProgressTextChanged ( const QString &  text)
signal

Signal emitted when progress text has changed.

Parameters
textNew progress text to display;
void mvd::AbstractWorker::ProgressValueChanged ( int  value)
signal

Signal emitted when progress value has changed.

Parameters
valueNew progress value to display.
virtual QObject* mvd::AbstractWorker::virtual_Do ( )
privatepure virtual

Do job/task abstract method to implement.

Implemented in mvd::ImageImporter, and mvd::OverviewBuilder.

virtual QString mvd::AbstractWorker::virtual_GetFirstProgressText ( ) const
privatepure virtual

Implemented in mvd::ImageImporter, and mvd::OverviewBuilder.

Referenced by GetFirstProgressText().


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