This class is an abstract class Provides an interface to progress task mechanic. More...

#include <otbFilterWatcherBase.h>

Inheritance diagram for otb::FilterWatcherBase:

Collaboration diagram for otb::FilterWatcherBase:

Public Member Functions
	FilterWatcherBase (itk::ProcessObject process, const char comment="")
	FilterWatcherBase ()
	FilterWatcherBase (const FilterWatcherBase &)
virtual	~FilterWatcherBase ()
std::string	GetComment ()
const char *	GetNameOfClass ()
itk::ProcessObject *	GetProcess ()
itk::TimeProbe &	GetTimeProbe ()
void	operator= (const FilterWatcherBase &)

Protected Types
typedef itk::SimpleMemberCommand < FilterWatcherBase >	CommandType

Protected Member Functions
virtual void	EndFilter ()=0
virtual void	EndFilterCallback ()
virtual void	ShowProgress ()=0
virtual void	ShowProgressCallback ()
virtual void	StartFilter ()=0
virtual void	StartFilterCallback ()

Protected Attributes
std::string	m_Comment
bool	m_Ended
CommandType::Pointer	m_EndFilterCommand
unsigned long	m_EndTag
itk::ProcessObject::Pointer	m_Process
CommandType::Pointer	m_ProgressFilterCommand
unsigned long	m_ProgressTag
bool	m_Started
CommandType::Pointer	m_StartFilterCommand
unsigned long	m_StartTag
itk::TimeProbe	m_TimeProbe

Detailed Description

This class is an abstract class Provides an interface to progress task mechanic.

Implement your callbacks

ShowProgress : callback called for each completed pixel
StartFilter : callback called at the begin of process
EndFilter : callback called at the end of process

Definition at line 41 of file otbFilterWatcherBase.h.

Member Typedef Documentation

typedef itk::SimpleMemberCommand<FilterWatcherBase> otb::FilterWatcherBase::CommandType

protected

Internal type

Definition at line 133 of file otbFilterWatcherBase.h.

Constructor & Destructor Documentation

otb::FilterWatcherBase::FilterWatcherBase	(	itk::ProcessObject *	process,
		const char *	comment = `""`
	)

Constructor. Takes a ProcessObject to monitor and an optional comment string that is prepended to each event message.

Definition at line 39 of file otbFilterWatcherBase.cxx.

References EndFilterCallback(), ShowProgressCallback(), and StartFilterCallback().

otb::FilterWatcherBase::FilterWatcherBase ( )

Default constructor

Definition at line 27 of file otbFilterWatcherBase.cxx.

otb::FilterWatcherBase::FilterWatcherBase ( const FilterWatcherBase & watch )

Copy constructor

Definition at line 74 of file otbFilterWatcherBase.cxx.

References EndFilterCallback(), m_Comment, m_Process, m_TimeProbe, ShowProgressCallback(), and StartFilterCallback().

otb::FilterWatcherBase::~FilterWatcherBase ( )

virtual

Destructor.

Definition at line 157 of file otbFilterWatcherBase.cxx.

Member Function Documentation

virtual void otb::FilterWatcherBase::EndFilter ( )

protectedpure virtual

Callback method to show the EndEvent

Implemented in otb::StandardFilterWatcher, otb::StandardOneLineFilterWatcher, and otb::FltkFilterWatcher.

Referenced by EndFilterCallback().

virtual void otb::FilterWatcherBase::EndFilterCallback ( )

inlineprotectedvirtual

Callback method to show the EndEvent

Definition at line 105 of file otbFilterWatcherBase.h.

References EndFilter(), and m_Ended.

Referenced by FilterWatcherBase(), and operator=().

std::string otb::FilterWatcherBase::GetComment ( )

inline

Get the comment for the watcher.

Definition at line 75 of file otbFilterWatcherBase.h.

References m_Comment.

const char* otb::FilterWatcherBase::GetNameOfClass ( )

inline

Definition at line 62 of file otbFilterWatcherBase.h.

References itk::SmartPointer< TObjectType >::GetPointer(), and m_Process.

itk::ProcessObject* otb::FilterWatcherBase::GetProcess ( )

inline

Methods to access member data Get a pointer to the process object being watched.

Definition at line 69 of file otbFilterWatcherBase.h.

References itk::SmartPointer< TObjectType >::GetPointer(), and m_Process.

itk::TimeProbe& otb::FilterWatcherBase::GetTimeProbe ( )

inline

Get a reference to the TimeProbe

Definition at line 81 of file otbFilterWatcherBase.h.

References m_TimeProbe.

void otb::FilterWatcherBase::operator= ( const FilterWatcherBase & watch )

operator=

Definition at line 116 of file otbFilterWatcherBase.cxx.

References EndFilterCallback(), m_Comment, m_Process, m_TimeProbe, ShowProgressCallback(), and StartFilterCallback().

Referenced by otb::StandardFilterWatcher::operator=(), and otb::StandardOneLineFilterWatcher::operator=().

virtual void otb::FilterWatcherBase::ShowProgress ( )

protectedpure virtual

Callback method to show the ProgressEvent

Implemented in otb::StandardFilterWatcher, otb::StandardOneLineFilterWatcher, and otb::FltkFilterWatcher.

Referenced by ShowProgressCallback().

virtual void otb::FilterWatcherBase::ShowProgressCallback ( )

inlineprotectedvirtual

Callback method to show the ProgressEvent

Definition at line 89 of file otbFilterWatcherBase.h.

References ShowProgress().

Referenced by FilterWatcherBase(), and operator=().

virtual void otb::FilterWatcherBase::StartFilter ( )

protectedpure virtual

Callback method to show the StartEvent

Implemented in otb::StandardFilterWatcher, otb::StandardOneLineFilterWatcher, and otb::FltkFilterWatcher.

Referenced by StartFilterCallback().

virtual void otb::FilterWatcherBase::StartFilterCallback ( )

inlineprotectedvirtual

Callback method to show the StartEvent

Definition at line 95 of file otbFilterWatcherBase.h.

References m_Started, and StartFilter().

Referenced by FilterWatcherBase(), and operator=().

Member Data Documentation

std::string otb::FilterWatcherBase::m_Comment

protected

Associated comment

Definition at line 127 of file otbFilterWatcherBase.h.

Referenced by FilterWatcherBase(), GetComment(), and operator=().

bool otb::FilterWatcherBase::m_Ended

protected

Some filters (for ex. persistents) invoke the EndEvent several times Work around this by remembering if it was called or not

Definition at line 159 of file otbFilterWatcherBase.h.

Referenced by EndFilterCallback().

CommandType::Pointer otb::FilterWatcherBase::m_EndFilterCommand

protected

End filter callback

Definition at line 139 of file otbFilterWatcherBase.h.

unsigned long otb::FilterWatcherBase::m_EndTag

protected

End observer

Definition at line 148 of file otbFilterWatcherBase.h.

itk::ProcessObject::Pointer otb::FilterWatcherBase::m_Process

protected

Abstract process object

Definition at line 130 of file otbFilterWatcherBase.h.

Referenced by FilterWatcherBase(), GetNameOfClass(), GetProcess(), and operator=().

CommandType::Pointer otb::FilterWatcherBase::m_ProgressFilterCommand

protected

Progress filter callback

Definition at line 142 of file otbFilterWatcherBase.h.

unsigned long otb::FilterWatcherBase::m_ProgressTag

protected

Progress observer

Definition at line 151 of file otbFilterWatcherBase.h.

bool otb::FilterWatcherBase::m_Started

protected

Some filters (for ex. persistents) invoke the StartEvent several times Work around this by remembering if it was called or not

Definition at line 155 of file otbFilterWatcherBase.h.

Referenced by StartFilterCallback().

CommandType::Pointer otb::FilterWatcherBase::m_StartFilterCommand

protected

Start filter callback

Definition at line 136 of file otbFilterWatcherBase.h.

unsigned long otb::FilterWatcherBase::m_StartTag

protected

Start oberserver

Definition at line 145 of file otbFilterWatcherBase.h.

itk::TimeProbe otb::FilterWatcherBase::m_TimeProbe

protected

Computing time

Definition at line 124 of file otbFilterWatcherBase.h.

Referenced by FilterWatcherBase(), GetTimeProbe(), and operator=().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation