otb::FilterWatcherBase Class Reference

#include <otbFilterWatcherBase.h>

Inheritance diagram for otb::FilterWatcherBase:

Collaboration diagram for otb::FilterWatcherBase:

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

Protected Member Functions
virtual void	ShowProgressCallback ()
typedef itk::SimpleMemberCommand< FilterWatcherBase >	CommandType
otb::Stopwatch	m_Stopwatch
std::string	m_Comment
itk::ProcessObject::Pointer	m_Process
CommandType::Pointer	m_StartFilterCommand
CommandType::Pointer	m_EndFilterCommand
CommandType::Pointer	m_ProgressFilterCommand
unsigned long	m_StartTag
unsigned long	m_EndTag
unsigned long	m_ProgressTag
bool	m_Started
bool	m_Ended
virtual void	StartFilterCallback ()
virtual void	EndFilterCallback ()
virtual void	ShowProgress ()=0
virtual void	StartFilter ()=0
virtual void	EndFilter ()=0

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 48 of file otbFilterWatcherBase.h.

Member Typedef Documentation

CommandType

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

protected

Internal type

Definition at line 140 of file otbFilterWatcherBase.h.

Constructor & Destructor Documentation

FilterWatcherBase() [1/3]

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.

FilterWatcherBase() [2/3]

otb::FilterWatcherBase::FilterWatcherBase

(

)

Default constructor

FilterWatcherBase() [3/3]

otb::FilterWatcherBase::FilterWatcherBase

(

const FilterWatcherBase &

)

Copy constructor

~FilterWatcherBase()

virtual otb::FilterWatcherBase::~FilterWatcherBase ( )

virtual

Destructor.

Member Function Documentation

EndFilter()

virtual void otb::FilterWatcherBase::EndFilter ( )

protectedpure virtual

Callback method to show the EndEvent

Implemented in otb::StandardOneLineFilterWatcher< PrintCallbackType >, otb::StandardOneLineFilterWatcher<>, and otb::StandardFilterWatcher.

EndFilterCallback()

virtual void otb::FilterWatcherBase::EndFilterCallback ( )

inlineprotectedvirtual

Callback method to show the EndEvent

Definition at line 111 of file otbFilterWatcherBase.h.

GetComment()

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

inline

Get the comment for the watcher.

Definition at line 81 of file otbFilterWatcherBase.h.

GetNameOfClass()

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

inline

Definition at line 67 of file otbFilterWatcherBase.h.

GetProcess()

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

inline

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

Definition at line 75 of file otbFilterWatcherBase.h.

GetStopwatch()

otb::Stopwatch& otb::FilterWatcherBase::GetStopwatch ( )

inline

Get a reference to the Stopwatch

Definition at line 87 of file otbFilterWatcherBase.h.

operator=()

void otb::FilterWatcherBase::operator=

(

const FilterWatcherBase &

)

operator=

ShowProgress()

virtual void otb::FilterWatcherBase::ShowProgress ( )

protectedpure virtual

Callback method to show the ProgressEvent

Implemented in otb::StandardOneLineFilterWatcher< PrintCallbackType >, otb::StandardOneLineFilterWatcher<>, and otb::StandardFilterWatcher.

ShowProgressCallback()

virtual void otb::FilterWatcherBase::ShowProgressCallback ( )

inlineprotectedvirtual

Callback method to show the ProgressEvent

Definition at line 94 of file otbFilterWatcherBase.h.

StartFilter()

virtual void otb::FilterWatcherBase::StartFilter ( )

protectedpure virtual

Callback method to show the StartEvent

Implemented in otb::StandardOneLineFilterWatcher< PrintCallbackType >, otb::StandardOneLineFilterWatcher<>, and otb::StandardFilterWatcher.

StartFilterCallback()

virtual void otb::FilterWatcherBase::StartFilterCallback ( )

inlineprotectedvirtual

Callback method to show the StartEvent

Definition at line 100 of file otbFilterWatcherBase.h.

Member Data Documentation

m_Comment

std::string otb::FilterWatcherBase::m_Comment

protected

Associated comment

Definition at line 134 of file otbFilterWatcherBase.h.

m_Ended

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 166 of file otbFilterWatcherBase.h.

m_EndFilterCommand

CommandType::Pointer otb::FilterWatcherBase::m_EndFilterCommand

protected

End filter callback

Definition at line 146 of file otbFilterWatcherBase.h.

m_EndTag

unsigned long otb::FilterWatcherBase::m_EndTag

protected

End observer

Definition at line 155 of file otbFilterWatcherBase.h.

m_Process

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

protected

Abstract process object

Definition at line 137 of file otbFilterWatcherBase.h.

m_ProgressFilterCommand

CommandType::Pointer otb::FilterWatcherBase::m_ProgressFilterCommand

protected

Progress filter callback

Definition at line 149 of file otbFilterWatcherBase.h.

m_ProgressTag

unsigned long otb::FilterWatcherBase::m_ProgressTag

protected

Progress observer

Definition at line 158 of file otbFilterWatcherBase.h.

m_Started

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 162 of file otbFilterWatcherBase.h.

m_StartFilterCommand

CommandType::Pointer otb::FilterWatcherBase::m_StartFilterCommand

protected

Start filter callback

Definition at line 143 of file otbFilterWatcherBase.h.

m_StartTag

unsigned long otb::FilterWatcherBase::m_StartTag

protected

Start oberserver

Definition at line 152 of file otbFilterWatcherBase.h.

m_Stopwatch

otb::Stopwatch otb::FilterWatcherBase::m_Stopwatch

protected

Computing time

Definition at line 131 of file otbFilterWatcherBase.h.

---

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

• otbFilterWatcherBase.h