Progress monitoring, event handling and abort signalling. More...

#include <edl/smartptr.h>
#include <edl/ircobject.h>

Include dependency graph for iabort.h:

This graph shows which files directly or indirectly include this file:

Classes
class	IAbort
	A simple class to signal an abort in processing. More...
class	IProgressTick
	An abstract class allowing a callback to monitor the progress of a task. The callback can either pass an integer (from 0 to a maximum value) or a float (0.0 to 1.0) which represents the progress of the task. The task needs to call the tick() method to indicate incremental progress. If the task has completed (even if it's premature) then tickMax() should be called instead of tick(). More...
class	IProgressEventHandler
	An abstract class allowing a callback respond to events during the processing of a document. It is up to the handler to decide what actions to perform when these events are received. More...
class	IProgressMonitor
	An abstract class encapsulating both an IProgressTick and an IAbort so that the caller can monitor the progress and/or abort the processing. More...

Macros
#define	CHECKABORT(abort)
	A useful macro to throw the exception `EDL_ERR_ABORTED` if the given IAbort notes that it has been signalled.
#define	PROGRESSTICK(progressTick)
#define	PROGRESSTICKMAX(progressTick)

Functions
	DECL_SMART_PTR (IAbort)
	DECL_SMART_PTR (IProgressTick)
	DECL_SMART_PTR (IProgressEventHandler)
	DECL_SMART_PTR (IProgressMonitor)

Detailed Description

Progress monitoring, event handling and abort signalling.

Macro Definition Documentation

#define CHECKABORT ( abort )

Value:

THROW_IF((abort) && (abort)->abortSignalled(), EDL_ERR_ABORTED);

@ EDL_ERR_ABORTED

Job aborted by user.

Definition edlerrors.h:41

A useful macro to throw the exception EDL_ERR_ABORTED if the given IAbort notes that it has been signalled.

#define PROGRESSTICK ( progressTick )

Value:

{ if (progressTick) (progressTick)->tick(); }

#define PROGRESSTICKMAX ( progressTick )

Value:

{ if (progressTick) (progressTick)->tickMax(); }

DECL_SMART_PTR ( IAbort )

DECL_SMART_PTR ( IProgressEventHandler )

DECL_SMART_PTR ( IProgressMonitor )

DECL_SMART_PTR ( IProgressTick )