iAProgress Class Reference

Connects computation with progress listeners through signals. More...

#include <iAProgress.h>

Inheritance diagram for iAProgress:

Collaboration diagram for iAProgress:

Public Types
typedef itk::MemberCommand< iAProgress >	CommandType

Signals
void	progress (int p)
	Signal emitted whenever the progress has changed. More...
void	statusChanged (QString const &status)
	Signal emitted whenever the status has changed. More...

Public Member Functions
void	emitProgress (int p)
	Trigger a progress event manually. More...
void	observe (itk::Object *caller)
	observe an ITK algorithm (and pass on its progress report) More...
void	observe (vtkAlgorithm *caller)
	observe a VTK algorithm (and pass on its progress report) More...
void	setStatus (QString const &status)
	Set additional status information. More...
void	processEvent (itk::Object *caller, const itk::EventObject &event)
void	constProcessEvent (const itk::Object *caller, const itk::EventObject &event)

Detailed Description

Connects computation with progress listeners through signals.

Can be used to track progress of vtk and itk filters, and provides an interface for manual progress tracking.

Member Typedef Documentation

CommandType

typedef itk::MemberCommand< iAProgress > iAProgress::CommandType

Member Function Documentation

constProcessEvent()

void iAProgress::constProcessEvent	(	const itk::Object *	caller,
		const itk::EventObject &	event
	)

emitProgress()

void iAProgress::emitProgress

(

int

p

)

Trigger a progress event manually.

Parameters

p	the current percentage of progress (number between 0 and 100)

observe() [1/2]

void iAProgress::observe

(

itk::Object *

caller

)

observe an ITK algorithm (and pass on its progress report)

Parameters

caller

the ITK algorithm to observe

observe() [2/2]

void iAProgress::observe

(

vtkAlgorithm *

caller

)

observe a VTK algorithm (and pass on its progress report)

Parameters

caller

the VTK algorithm to observe

processEvent()

void iAProgress::processEvent	(	itk::Object *	caller,
		const itk::EventObject &	event
	)

Event handlers for ITK progress events

progress

void iAProgress::progress ( int  p )

signal

Signal emitted whenever the progress has changed.

Connect this to a method that updates the indication of the current progression to the user.

Parameters

p	the current percentage of progress (number between 0 and 100)

setStatus()

void iAProgress::setStatus

(

QString const &

status

)

Set additional status information.

Parameters

status

the new status to report to the user

statusChanged

void iAProgress::statusChanged ( QString const &  status )

signal

Signal emitted whenever the status has changed.

Connect this to a method that updates the output of the status to the user.

Parameters

status

the new status.

---

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

• core/src/iAProgress.h
• core/src/iAProgress.cpp