A simple class to signal an abort in processing. More...

#include <edl/iabort.h>

Inheritance diagram for IAbort:

Public Member Functions
virtual	~IAbort ()
virtual void	resetSignal ()=0
	Reset the abort object to an unsignalled state.
virtual void	signalAbort ()=0
	Signal that the output operation should be aborted.
virtual bool	abortSignalled ()=0
	Determine if the abort has been signalled.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static EDL_API IAbortPtr	create ()
	Create an abort signal.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

A simple class to signal an abort in processing.

Constructor & Destructor Documentation

virtual IAbort::~IAbort ( )

inlinevirtual

virtual bool IAbort::abortSignalled ( )

pure virtual

Determine if the abort has been signalled.

Returns: bool True or false, indicating whether the abort has been signalled.

EDL_API IAbortPtr IAbort::create ( )

static

Create an abort signal.

virtual void IAbort::resetSignal ( )

pure virtual

Reset the abort object to an unsignalled state.

virtual void IAbort::signalAbort ( )

pure virtual

Signal that the output operation should be aborted.

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