ReportingTask Class Reference

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

Inheritance diagram for ReportingTask:

Public Member Functions
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
Public Member Functions inherited from Task
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
virtual uiRetVal	errorWithDetails () const
virtual bool	execute ()=0
virtual Control	getState () const
virtual std::int64_t	nrDone () const
virtual std::int64_t	totalNr () const
virtual uiString	uiMessage () const
	will be message() again in 7.x More...
virtual uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
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. More...
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. More...
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

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() More...
void	updateProgressMeter (bool forced=false, std::int64_t *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
int	lastupdate_
ProgressMeter *	progressmeter_ = nullptr

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
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()

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

protected

Member Function Documentation

getProgress()

void ReportingTask::getProgress

(

const ReportingTask &

)

incrementProgress()

void ReportingTask::incrementProgress ( )

protected

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.

Reimplemented in VolProc::ChainOutput.

updateProgressMeter()

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

protected

updateReportedName()

void ReportingTask::updateReportedName ( )

protected

Member Data Documentation

lastupdate_

int ReportingTask::lastupdate_

private

progressmeter_

ProgressMeter* ReportingTask::progressmeter_ = nullptr

private

progressUpdated

Notifier<ReportingTask> ReportingTask::progressUpdated