IProgressMonitor Class Reference

An abstract class encapsulating both an IProgressTick and an IAbort so that the caller can monitor the progress and/or abort the processing. More...

#include <iabort.h>

Inheritance diagram for IProgressMonitor:

Public Member Functions
virtual IProgressTickPtr	getProgressTick () const =0
	Return the IProgressTick object or NULL if there was no such object.
virtual IAbortPtr	getAbort () const =0
	Return the smart pointer to an IAbort object.
virtual void	setProgressEventHandler (const IProgressEventHandlerPtr &progressEventHandler)=0
	Set the IProgressEventHandler object for the progress monitor.
virtual void	postEvent (IProgressEventHandler::Event evt)=0
	Posts an event via the attached progress event handler for this monitor object.
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 IProgressMonitorPtr	create (const IProgressTickPtr &progressTick, const IAbortPtr &abort)
	Create smart pointer to an IProgressMonitor object.
static EDL_API IProgressMonitorPtr	create (const IProgressTickPtr &progressTick)
	Create smart pointer to an IProgressMonitor object.
static EDL_API IProgressMonitorPtr	create (const IAbortPtr &abort)
	Create smart pointer to an IProgressMonitor object.

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

Detailed Description

An abstract class encapsulating both an IProgressTick and an IAbort so that the caller can monitor the progress and/or abort the processing.

Member Function Documentation

create() [1/3]

static EDL_API IProgressMonitorPtr IProgressMonitor::create ( const IAbortPtr & abort )

static

Create smart pointer to an IProgressMonitor object.

Parameters

[in]

abort

A smart pointer to an IAbort object which can be NULL if no object was passed in.

Returns

IProgressMonitorPtr The IProgressMonitorPtr object

create() [2/3]

static EDL_API IProgressMonitorPtr IProgressMonitor::create ( const IProgressTickPtr & progressTick )

static

Create smart pointer to an IProgressMonitor object.

Parameters

[in]

progressTick

A smart pointer to an IProgressTick object which can be NULL if no object was passed in.

Returns

IProgressMonitorPtr The IProgressMonitorPtr object

create() [3/3]

static EDL_API IProgressMonitorPtr IProgressMonitor::create ( const IProgressTickPtr & progressTick, const IAbortPtr & abort )

static

Create smart pointer to an IProgressMonitor object.

Parameters

[in]	progressTick	A smart pointer to an IProgressTick object which can be NULL of no object was passed in.
[in]	abort	A smart pointer to an IAbort object which can be NULL of no object was passed in.

Returns

IProgressMonitorPtr The IProgressMonitorPtr object

getAbort()

virtual IAbortPtr IProgressMonitor::getAbort ( ) const

pure virtual

Return the smart pointer to an IAbort object.

Returns

IAbortPtr The smart pointer to the IAbort object or NULL if there is no such object.

getProgressTick()

virtual IProgressTickPtr IProgressMonitor::getProgressTick ( ) const

pure virtual

Return the IProgressTick object or NULL if there was no such object.

Returns

IProgressTickPtr The smart pointer to the IProgressTick object or NULL if there is no such object.

postEvent()

virtual void IProgressMonitor::postEvent ( IProgressEventHandler::Event evt )

pure virtual

Posts an event via the attached progress event handler for this monitor object.

Parameters

[in]

evt

The event to post to the progress event handler.

setProgressEventHandler()

virtual void IProgressMonitor::setProgressEventHandler ( const IProgressEventHandlerPtr & progressEventHandler )

pure virtual

Set the IProgressEventHandler object for the progress monitor.

Parameters

[in]

progressEventHandler

The progress event handler.

---

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

• iabort.h