OTB  6.7.0
Orfeo Toolbox
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
otb::WriterWatcherBase Class Referenceabstract

#include <otbWriterWatcherBase.h>

+ Inheritance diagram for otb::WriterWatcherBase:
+ Collaboration diagram for otb::WriterWatcherBase:

Public Member Functions

std::string GetComment () const
 
const char * GetNameOfClass ()
 
itk::ProcessObjectGetProcess ()
 
otb::StopwatchGetStopwatch ()
 
void operator= (const WriterWatcherBase &)
 
 WriterWatcherBase (itk::ProcessObject *process, const char *comment="")
 
 WriterWatcherBase (itk::ProcessObject *process, itk::ProcessObject *source, const char *comment="")
 
 WriterWatcherBase ()
 
 WriterWatcherBase (const WriterWatcherBase &)
 
virtual ~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
 
otb::Stopwatch m_Stopwatch
 

Detailed Description

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

Implement your callbacks

Definition at line 51 of file otbWriterWatcherBase.h.

Member Typedef Documentation

Internal type

Definition at line 134 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.

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

otb::WriterWatcherBase::WriterWatcherBase ( )

Default constructor

otb::WriterWatcherBase::WriterWatcherBase ( const WriterWatcherBase )

Copy constructor

virtual otb::WriterWatcherBase::~WriterWatcherBase ( )
virtual

Destructor.

Member Function Documentation

virtual void otb::WriterWatcherBase::EndFilter ( )
protectedpure virtual

Callback method to show the EndEvent from the filter

Implemented in otb::StandardWriterWatcher.

virtual void otb::WriterWatcherBase::EndWriter ( )
protectedpure virtual

Callback method to show the EndEvent from the writer

Implemented in otb::StandardWriterWatcher.

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

Get the comment for the watcher.

Definition at line 90 of file otbWriterWatcherBase.h.

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

Definition at line 76 of file otbWriterWatcherBase.h.

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

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

Definition at line 84 of file otbWriterWatcherBase.h.

otb::Stopwatch& otb::WriterWatcherBase::GetStopwatch ( )
inline

Get a reference to the Stopwatch

Definition at line 96 of file otbWriterWatcherBase.h.

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

operator=

virtual void otb::WriterWatcherBase::ShowFilterProgress ( )
protectedpure virtual

Callback method to show the ProgressEvent from the filter

Implemented in otb::StandardWriterWatcher.

virtual void otb::WriterWatcherBase::ShowWriterProgress ( )
protectedpure virtual

Callback method to show the ProgressEvent from the writer

Implemented in otb::StandardWriterWatcher.

virtual void otb::WriterWatcherBase::StartFilter ( )
protectedpure virtual

Callback method to show the StartEvent from the filter

Implemented in otb::StandardWriterWatcher.

virtual void otb::WriterWatcherBase::StartWriter ( )
protectedpure virtual

Callback method to show the StartEvent from the writer

Implemented in otb::StandardWriterWatcher.

Member Data Documentation

std::string otb::WriterWatcherBase::m_Comment
protected

Associated comment

Definition at line 125 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_EndFilterCommand
protected

End writer callback

Definition at line 149 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_EndFilterTag
protected

End observer

Definition at line 167 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_EndWriterCommand
protected

End writer callback

Definition at line 140 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_EndWriterTag
protected

End observer

Definition at line 158 of file otbWriterWatcherBase.h.

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

Abstract process object

Definition at line 128 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_ProgressFilterCommand
protected

Progress writer callback

Definition at line 152 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_ProgressFilterTag
protected

Progress observer

Definition at line 170 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_ProgressWriterCommand
protected

Progress writer callback

Definition at line 143 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_ProgressWriterTag
protected

Progress observer

Definition at line 161 of file otbWriterWatcherBase.h.

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

Second abstract process object representing the source

Definition at line 131 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_StartFilterCommand
protected

Start filter callback

Definition at line 146 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_StartFilterTag
protected

Start oberserver

Definition at line 164 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_StartWriterCommand
protected

Start writer callback

Definition at line 137 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_StartWriterTag
protected

Start oberserver

Definition at line 155 of file otbWriterWatcherBase.h.

otb::Stopwatch otb::WriterWatcherBase::m_Stopwatch
protected

Computing time

Definition at line 122 of file otbWriterWatcherBase.h.


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