Orfeo Toolbox  4.0
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | 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 &)
 
std::string GetComment () const
 
const char * GetNameOfClass ()
 
itk::ProcessObjectGetProcess ()
 
const unsigned int & GetStars () const
 
itk::TimeProbeGetTimeProbe ()
 
void operator= (const StandardWriterWatcher &)
 
void SetStars (int count)
 

Protected Types

typedef
itk::SimpleMemberCommand
< WriterWatcherBase
CommandType
 

Protected Member Functions

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

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
 

Private Attributes

unsigned int m_StarsCount
 

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.

Member Typedef Documentation

Internal type

Definition at line 126 of file otbWriterWatcherBase.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.

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

Get the comment for the watcher.

Definition at line 82 of file otbWriterWatcherBase.h.

References otb::WriterWatcherBase::m_Comment.

const char* otb::WriterWatcherBase::GetNameOfClass ( )
inlineinherited
itk::ProcessObject* otb::WriterWatcherBase::GetProcess ( )
inlineinherited

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 otb::WriterWatcherBase::m_Process.

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

Definition at line 79 of file otbStandardWriterWatcher.h.

References m_StarsCount.

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

Get a reference to the TimeProbe

Definition at line 88 of file otbWriterWatcherBase.h.

References otb::WriterWatcherBase::m_TimeProbe.

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.

References itk::blanks.

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

std::string otb::WriterWatcherBase::m_Comment
protectedinherited
CommandType::Pointer otb::WriterWatcherBase::m_EndFilterCommand
protectedinherited

End writer callback

Definition at line 141 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_EndFilterTag
protectedinherited

End observer

Definition at line 159 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_EndWriterCommand
protectedinherited

End writer callback

Definition at line 132 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_EndWriterTag
protectedinherited

End observer

Definition at line 150 of file otbWriterWatcherBase.h.

itk::ProcessObject::Pointer otb::WriterWatcherBase::m_Process
protectedinherited
CommandType::Pointer otb::WriterWatcherBase::m_ProgressFilterCommand
protectedinherited

Progress writer callback

Definition at line 144 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_ProgressFilterTag
protectedinherited

Progress observer

Definition at line 162 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_ProgressWriterCommand
protectedinherited

Progress writer callback

Definition at line 135 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_ProgressWriterTag
protectedinherited

Progress observer

Definition at line 153 of file otbWriterWatcherBase.h.

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

Second abstract process object representing the source

Definition at line 123 of file otbWriterWatcherBase.h.

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

unsigned int otb::StandardWriterWatcher::m_StarsCount
private

Stars coutning

Definition at line 110 of file otbStandardWriterWatcher.h.

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

CommandType::Pointer otb::WriterWatcherBase::m_StartFilterCommand
protectedinherited

Start filter callback

Definition at line 138 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_StartFilterTag
protectedinherited

Start oberserver

Definition at line 156 of file otbWriterWatcherBase.h.

CommandType::Pointer otb::WriterWatcherBase::m_StartWriterCommand
protectedinherited

Start writer callback

Definition at line 129 of file otbWriterWatcherBase.h.

unsigned long otb::WriterWatcherBase::m_StartWriterTag
protectedinherited

Start oberserver

Definition at line 147 of file otbWriterWatcherBase.h.

itk::TimeProbe otb::WriterWatcherBase::m_TimeProbe
protectedinherited

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

Generated at Sat Mar 8 2014 18:59:32 for Orfeo Toolbox with doxygen 1.8.3.1