ReportingTask Class Reference

Helper class for all task implementations which need a progress meter. More...

#include <task.h>

Inheritance diagram for ReportingTask:

Public Member Functions
	ReportingTask (const ReportingTask &)=delete
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
ReportingTask &	operator= (const ReportingTask &)=delete
void	setSimpleMeter (bool yn, int repperc)
int	simpleMeterStep () const
bool	useSimpleMeter () const
Public Member Functions inherited from Task
	Task (const Task &)=delete
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute()
virtual uiRetVal	errorWithDetails () const
virtual bool	execute ()=0
virtual Control	getState () const
virtual od_int64	nrDone () const
Task &	operator= (const Task &)=delete
virtual od_int64	totalNr () const
virtual uiString	uiMessage () const
virtual uiString	uiNrDoneText () const
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)
	NamedCallBacker (const NamedCallBacker &)=delete
	~NamedCallBacker ()
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
NamedCallBacker &	operator= (const NamedCallBacker &)=delete
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object.
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use.
CallBacker &	operator= (const CallBacker &)=delete
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

Static Public Member Functions
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)
static bool	needSimpleLogging (const IOPar &)
static const char *	sKeySimpleLogging ()
static const char *	sKeySimpleLoggingStep ()
Static Public Member Functions inherited from Task
static uiString	uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Public Attributes
Notifier< ReportingTask >	progressUpdated

Protected Member Functions
	ReportingTask (const char *nm=nullptr)
void	incrementProgress ()
ProgressMeter *	progressMeter () const
void	reportProgressFinished ()
void	reportProgressStarted ()
void	resetProgress ()
void	setProgressMeter (ProgressMeter *) override
	Must be called before execute()
void	updateProgressMeter (bool forced=false, od_int64 *totalnr=0)
void	updateReportedName ()
Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Private Attributes
od_int64	lastupdate_
ProgressMeter *	progressmeter_ = nullptr
int	repperc_ = 5
bool	simplemeter_ = false

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Protected Attributes inherited from Task
Control	control_ = Task::Run
Threads::ConditionVar *	workcontrolcondvar_ = nullptr
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

Helper class for all task implementations which need a progress meter.

<>

Constructor & Destructor Documentation

~ReportingTask()

virtual ReportingTask::~ReportingTask ( )

virtual

ReportingTask() [1/2]

ReportingTask::ReportingTask ( const ReportingTask & )

delete

ReportingTask() [2/2]

ReportingTask::ReportingTask ( const char * nm = nullptr )

protected

Member Function Documentation

getProgress()

void ReportingTask::getProgress

(

const ReportingTask &

)

getTextProgressMeter()

static PtrMan< ProgressMeter > ReportingTask::getTextProgressMeter ( od_ostream & , const IOPar * iop = nullptr )

static

incrementProgress()

void ReportingTask::incrementProgress ( )

protected

needSimpleLogging()

static bool ReportingTask::needSimpleLogging ( const IOPar & )

static

operator=()

ReportingTask & ReportingTask::operator= ( const ReportingTask & )

delete

progressMeter()

ProgressMeter * ReportingTask::progressMeter ( ) const

inlineprotected

reportProgressFinished()

void ReportingTask::reportProgressFinished ( )

protected

reportProgressStarted()

void ReportingTask::reportProgressStarted ( )

protected

resetProgress()

void ReportingTask::resetProgress ( )

protected

setProgressMeter()

void ReportingTask::setProgressMeter ( ProgressMeter * )

overrideprotectedvirtual

Must be called before execute()

Reimplemented from Task.

setSimpleMeter()

void ReportingTask::setSimpleMeter	(	bool	yn,
		int	repperc )

simpleMeterStep()

int ReportingTask::simpleMeterStep

(

)

const

sKeySimpleLogging()

static const char * ReportingTask::sKeySimpleLogging ( )

static

sKeySimpleLoggingStep()

static const char * ReportingTask::sKeySimpleLoggingStep ( )

static

updateProgressMeter()

void ReportingTask::updateProgressMeter ( bool forced = false, od_int64 * totalnr = 0 )

protected

updateReportedName()

void ReportingTask::updateReportedName ( )

protected

useSimpleMeter()

bool ReportingTask::useSimpleMeter

(

)

const

Member Data Documentation

lastupdate_

od_int64 ReportingTask::lastupdate_

private

progressmeter_

ProgressMeter* ReportingTask::progressmeter_ = nullptr

private

progressUpdated

Notifier<ReportingTask> ReportingTask::progressUpdated

repperc_

int ReportingTask::repperc_ = 5

private

simplemeter_

bool ReportingTask::simplemeter_ = false

private