Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::StandardWriterWatcher Class Reference

This class shows the percentage progress execution of the pipeline filtering process. More...

#include <otbStandardWriterWatcher.h>

+ Inheritance diagram for otb::StandardWriterWatcher:
+ Collaboration diagram for otb::StandardWriterWatcher:

Public Member Functions

 StandardWriterWatcher (itk::ProcessObject *process, const char *comment="")
 
 StandardWriterWatcher (itk::ProcessObject *process, itk::ProcessObject *source, const char *comment="")
 
 StandardWriterWatcher (itk::ProcessObject *process, const std::string &comment="")
 
 StandardWriterWatcher (itk::ProcessObject *process, itk::ProcessObject *source, const std::string &comment="")
 
 StandardWriterWatcher ()
 
 StandardWriterWatcher (const StandardWriterWatcher &)
 
const unsigned int & GetStars () const
 
void operator= (const StandardWriterWatcher &)
 
void SetStars (int count)
 
- Public Member Functions inherited from otb::WriterWatcherBase
 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::ProcessObjectGetProcess ()
 
itk::TimeProbeGetTimeProbe ()
 
void operator= (const WriterWatcherBase &)
 

Protected Member Functions

virtual void EndFilter ()
 
virtual void EndWriter ()
 
virtual void ShowFilterProgress ()
 
virtual void ShowProgress ()
 
virtual void ShowWriterProgress ()
 
virtual void StartFilter ()
 
virtual void StartWriter ()
 

Private Attributes

unsigned int m_StarsCount
 

Additional Inherited Members

- Protected Types inherited from otb::WriterWatcherBase
typedef
itk::SimpleMemberCommand
< WriterWatcherBase
CommandType
 
- Protected Attributes inherited from otb::WriterWatcherBase
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 shows the percentage progress execution of the pipeline filtering process.

This class is based on Observer design pattern Abstract class ProcessObject is the subject Event are observers

Usage example:

typedef itk::BinaryThresholdImageWriter<ImageType> WriterType;
WriterType::Pointer thresholdWriter = WriterType::New();
StandardWriterWatcher watcher(thresholdWriter, "Threshold");
See Also
itk::SimpleWriterWatcher
otb::fltkWriterWatcher

Definition at line 49 of file otbStandardWriterWatcher.h.

Constructor & Destructor Documentation

otb::StandardWriterWatcher::StandardWriterWatcher ( 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 27 of file otbStandardWriterWatcher.cxx.

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

Definition at line 35 of file otbStandardWriterWatcher.cxx.

otb::StandardWriterWatcher::StandardWriterWatcher ( itk::ProcessObject process,
const std::string &  comment = "" 
)

Definition at line 43 of file otbStandardWriterWatcher.cxx.

otb::StandardWriterWatcher::StandardWriterWatcher ( itk::ProcessObject process,
itk::ProcessObject source,
const std::string &  comment = "" 
)

Definition at line 51 of file otbStandardWriterWatcher.cxx.

otb::StandardWriterWatcher::StandardWriterWatcher ( )
inline

Default constructor

Definition at line 66 of file otbStandardWriterWatcher.h.

otb::StandardWriterWatcher::StandardWriterWatcher ( const StandardWriterWatcher watch)

Copy constructor

Definition at line 59 of file otbStandardWriterWatcher.cxx.

References m_StarsCount.

Member Function Documentation

virtual void otb::StandardWriterWatcher::EndFilter ( )
inlineprotectedvirtual

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

Definition at line 102 of file otbStandardWriterWatcher.h.

void otb::StandardWriterWatcher::EndWriter ( )
protectedvirtual

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

Definition at line 158 of file otbStandardWriterWatcher.cxx.

const unsigned int& otb::StandardWriterWatcher::GetStars ( ) const
inline

Definition at line 79 of file otbStandardWriterWatcher.h.

References m_StarsCount.

void otb::StandardWriterWatcher::operator= ( const StandardWriterWatcher watch)

operator=

Definition at line 67 of file otbStandardWriterWatcher.cxx.

References m_StarsCount, and otb::WriterWatcherBase::operator=().

void otb::StandardWriterWatcher::SetStars ( int  count)
inline

Get/Set number of stars

Definition at line 75 of file otbStandardWriterWatcher.h.

References m_StarsCount.

void otb::StandardWriterWatcher::ShowFilterProgress ( )
protectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

Definition at line 83 of file otbStandardWriterWatcher.cxx.

void otb::StandardWriterWatcher::ShowProgress ( )
protectedvirtual

This is the method invoked by ShowFilterProgress() and ShowWriterProgress()

Definition at line 90 of file otbStandardWriterWatcher.cxx.

void otb::StandardWriterWatcher::ShowWriterProgress ( )
protectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

Definition at line 76 of file otbStandardWriterWatcher.cxx.

virtual void otb::StandardWriterWatcher::StartFilter ( )
inlineprotectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Definition at line 99 of file otbStandardWriterWatcher.h.

void otb::StandardWriterWatcher::StartWriter ( )
protectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Definition at line 147 of file otbStandardWriterWatcher.cxx.

Member Data Documentation

unsigned int otb::StandardWriterWatcher::m_StarsCount
private

Stars coutning

Definition at line 110 of file otbStandardWriterWatcher.h.

Referenced by GetStars(), operator=(), SetStars(), and StandardWriterWatcher().


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