OTB  6.7.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 ()
 
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 Member Functions

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

Private Attributes

std::string m_Buffer
 
bool m_CoutIsConsole
 
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
 
otb::Stopwatch m_Stopwatch
 

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 56 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 74 of file otbStandardWriterWatcher.h.

otb::StandardWriterWatcher::StandardWriterWatcher ( const StandardWriterWatcher )

Copy constructor

Member Function Documentation

void otb::StandardWriterWatcher::EndFilter ( )
inlineoverrideprotectedvirtual

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

Definition at line 111 of file otbStandardWriterWatcher.h.

void otb::StandardWriterWatcher::EndWriter ( )
overrideprotectedvirtual

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 87 of file otbStandardWriterWatcher.h.

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

operator=

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

Get/Set number of stars

Definition at line 83 of file otbStandardWriterWatcher.h.

void otb::StandardWriterWatcher::ShowFilterProgress ( )
overrideprotectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

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

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

void otb::StandardWriterWatcher::ShowWriterProgress ( )
overrideprotectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

void otb::StandardWriterWatcher::StartFilter ( )
inlineoverrideprotectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Definition at line 108 of file otbStandardWriterWatcher.h.

void otb::StandardWriterWatcher::StartWriter ( )
overrideprotectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Member Data Documentation

std::string otb::StandardWriterWatcher::m_Buffer
private

Definition at line 123 of file otbStandardWriterWatcher.h.

bool otb::StandardWriterWatcher::m_CoutIsConsole
private

Definition at line 121 of file otbStandardWriterWatcher.h.

unsigned int otb::StandardWriterWatcher::m_StarsCount
private

Stars coutning

Definition at line 119 of file otbStandardWriterWatcher.h.


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