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

#include <otbWriterWatcherBase.h>

Inheritance diagram for otb::WriterWatcherBase:

Collaboration diagram for otb::WriterWatcherBase:

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

Protected Types
typedef itk::SimpleMemberCommand < WriterWatcherBase >	CommandType

Protected Member Functions
virtual void	EndFilter ()=0
virtual void	EndWriter ()=0
virtual void	ShowFilterProgress ()=0
virtual void	ShowWriterProgress ()=0
virtual void	StartFilter ()=0
virtual void	StartWriter ()=0

Protected Attributes
std::string	m_Comment
CommandType::Pointer	m_EndFilterCommand
unsigned long	m_EndFilterTag
CommandType::Pointer	m_EndWriterCommand
unsigned long	m_EndWriterTag
itk::ProcessObject::Pointer	m_Process
CommandType::Pointer	m_ProgressFilterCommand
unsigned long	m_ProgressFilterTag
CommandType::Pointer	m_ProgressWriterCommand
unsigned long	m_ProgressWriterTag
itk::ProcessObject::Pointer	m_SourceProcess
CommandType::Pointer	m_StartFilterCommand
unsigned long	m_StartFilterTag
CommandType::Pointer	m_StartWriterCommand
unsigned long	m_StartWriterTag
itk::TimeProbe	m_TimeProbe

Detailed Description

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

Implement your callbacks

ShowWriterProgress : callback called for each completed tile
StartWriter : callback called at the begin of tile writing
EndWriter : callback called at the end of tile writing
ShowFilterProgress : callback called for each completed pixel
StartFilter : callback called at the begin of filter execution for a given tile
EndFilter : callback called at the end of filter execution for a given tile

Definition at line 44 of file otbWriterWatcherBase.h.

Member Typedef Documentation

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

protected

Internal type

Definition at line 126 of file otbWriterWatcherBase.h.

Constructor & Destructor Documentation

otb::WriterWatcherBase::WriterWatcherBase	(	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 35 of file otbWriterWatcherBase.cxx.

References EndFilter(), EndWriter(), ShowFilterProgress(), ShowWriterProgress(), StartFilter(), and StartWriter().

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

This other constructor is provided so that the user can set a different processing filter than the one

just before process in the pipeline

Definition at line 92 of file otbWriterWatcherBase.cxx.

References itk::Object::AddObserver(), EndFilter(), EndWriter(), ShowFilterProgress(), ShowWriterProgress(), StartFilter(), and StartWriter().

otb::WriterWatcherBase::WriterWatcherBase ( )

Default constructor

Definition at line 27 of file otbWriterWatcherBase.cxx.

otb::WriterWatcherBase::WriterWatcherBase ( const WriterWatcherBase & watch )

Copy constructor

Definition at line 145 of file otbWriterWatcherBase.cxx.

References EndFilter(), EndWriter(), m_Comment, m_Process, m_SourceProcess, m_TimeProbe, ShowFilterProgress(), ShowWriterProgress(), StartFilter(), and StartWriter().

otb::WriterWatcherBase::~WriterWatcherBase ( )

virtual

Destructor.

Definition at line 329 of file otbWriterWatcherBase.cxx.

Member Function Documentation

virtual void otb::WriterWatcherBase::EndFilter ( )

protectedpure virtual

Callback method to show the EndEvent from the filter

Implemented in otb::StandardWriterWatcher, and otb::FltkWriterWatcher.

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

virtual void otb::WriterWatcherBase::EndWriter ( )

protectedpure virtual

Callback method to show the EndEvent from the writer

Implemented in otb::StandardWriterWatcher, and otb::FltkWriterWatcher.

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

std::string otb::WriterWatcherBase::GetComment ( ) const

inline

Get the comment for the watcher.

Definition at line 82 of file otbWriterWatcherBase.h.

References m_Comment.

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

inline

Definition at line 69 of file otbWriterWatcherBase.h.

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

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

inline

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

Definition at line 76 of file otbWriterWatcherBase.h.

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

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

inline

Get a reference to the TimeProbe

Definition at line 88 of file otbWriterWatcherBase.h.

References m_TimeProbe.

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

operator=

Definition at line 238 of file otbWriterWatcherBase.cxx.

References EndFilter(), EndWriter(), m_Comment, m_Process, m_SourceProcess, m_TimeProbe, ShowFilterProgress(), ShowWriterProgress(), StartFilter(), and StartWriter().

Referenced by otb::StandardWriterWatcher::operator=().

virtual void otb::WriterWatcherBase::ShowFilterProgress ( )

protectedpure virtual

Callback method to show the ProgressEvent from the filter

Implemented in otb::StandardWriterWatcher, and otb::FltkWriterWatcher.

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

virtual void otb::WriterWatcherBase::ShowWriterProgress ( )

protectedpure virtual

Callback method to show the ProgressEvent from the writer

Implemented in otb::StandardWriterWatcher, and otb::FltkWriterWatcher.

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

virtual void otb::WriterWatcherBase::StartFilter ( )

protectedpure virtual

Callback method to show the StartEvent from the filter

Implemented in otb::StandardWriterWatcher, and otb::FltkWriterWatcher.

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

virtual void otb::WriterWatcherBase::StartWriter ( )

protectedpure virtual

Callback method to show the StartEvent from the writer

Implemented in otb::StandardWriterWatcher, and otb::FltkWriterWatcher.

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

Member Data Documentation

std::string otb::WriterWatcherBase::m_Comment

protected

Associated comment

Definition at line 117 of file otbWriterWatcherBase.h.

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

CommandType::Pointer otb::WriterWatcherBase::m_EndFilterCommand

protected

End writer callback

Definition at line 141 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_EndFilterTag

protected

End observer

Definition at line 159 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_EndWriterCommand

protected

End writer callback

Definition at line 132 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_EndWriterTag

protected

End observer

Definition at line 150 of file otbWriterWatcherBase.h.

itk::ProcessObject::Pointer otb::WriterWatcherBase::m_Process

protected

Abstract process object

Definition at line 120 of file otbWriterWatcherBase.h.

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

CommandType::Pointer otb::WriterWatcherBase::m_ProgressFilterCommand

protected

Progress writer callback

Definition at line 144 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_ProgressFilterTag

protected

Progress observer

Definition at line 162 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_ProgressWriterCommand

protected

Progress writer callback

Definition at line 135 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_ProgressWriterTag

protected

Progress observer

Definition at line 153 of file otbWriterWatcherBase.h.

itk::ProcessObject::Pointer otb::WriterWatcherBase::m_SourceProcess

protected

Second abstract process object representing the source

Definition at line 123 of file otbWriterWatcherBase.h.

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

CommandType::Pointer otb::WriterWatcherBase::m_StartFilterCommand

protected

Start filter callback

Definition at line 138 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_StartFilterTag

protected

Start oberserver

Definition at line 156 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_StartWriterCommand

protected

Start writer callback

Definition at line 129 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_StartWriterTag

protected

Start oberserver

Definition at line 147 of file otbWriterWatcherBase.h.

itk::TimeProbe otb::WriterWatcherBase::m_TimeProbe

protected

Computing time

Definition at line 114 of file otbWriterWatcherBase.h.

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

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