OTB  5.0.0
Orfeo Toolbox
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::StandardWriterWatcher Class Reference

#include <otbStandardWriterWatcher.h>

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

Public Member Functions

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

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

Constructor. Takes a ProcessObject to monitor and an optional comment string that is prepended to each event message.

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

Default constructor

Definition at line 69 of file otbStandardWriterWatcher.h.

otb::StandardWriterWatcher::StandardWriterWatcher ( const StandardWriterWatcher )

Copy constructor

Member Function Documentation

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

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

Definition at line 106 of file otbStandardWriterWatcher.h.

virtual void otb::StandardWriterWatcher::EndWriter ( )
protectedvirtual

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

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

Get/Set number of stars

Definition at line 82 of file otbStandardWriterWatcher.h.

References m_StarsCount.

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

operator=

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

Get/Set number of stars

Definition at line 78 of file otbStandardWriterWatcher.h.

References m_StarsCount.

virtual void otb::StandardWriterWatcher::ShowFilterProgress ( )
protectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

virtual void otb::StandardWriterWatcher::ShowProgress ( )
protectedvirtual

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

virtual void otb::StandardWriterWatcher::ShowWriterProgress ( )
protectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

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

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Definition at line 103 of file otbStandardWriterWatcher.h.

virtual void otb::StandardWriterWatcher::StartWriter ( )
protectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Member Data Documentation

unsigned int otb::StandardWriterWatcher::m_StarsCount
private

Stars coutning

Definition at line 114 of file otbStandardWriterWatcher.h.

Referenced by GetStars(), and SetStars().


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