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

#include <otbStandardFilterWatcher.h>

+ Inheritance diagram for otb::StandardFilterWatcher:
+ Collaboration diagram for otb::StandardFilterWatcher:

Public Member Functions

void operator= (const StandardFilterWatcher &)
 
 StandardFilterWatcher (itk::ProcessObject *process, const char *comment="")
 
 StandardFilterWatcher (itk::ProcessObject *process, const std::string &comment="")
 
 StandardFilterWatcher ()
 
 StandardFilterWatcher (const StandardFilterWatcher &)
 
void SetStars (int count)
 
const int & GetStars () const
 
- Public Member Functions inherited from otb::FilterWatcherBase
 FilterWatcherBase (itk::ProcessObject *process, const char *comment="")
 
 FilterWatcherBase ()
 
 FilterWatcherBase (const FilterWatcherBase &)
 
std::string GetComment ()
 
const char * GetNameOfClass ()
 
itk::ProcessObjectGetProcess ()
 
otb::StopwatchGetStopwatch ()
 
void operator= (const FilterWatcherBase &)
 
virtual ~FilterWatcherBase ()
 

Protected Member Functions

void EndFilter () override
 
void ShowProgress () override
 
void StartFilter () override
 
- Protected Member Functions inherited from otb::FilterWatcherBase
virtual void ShowProgressCallback ()
 
virtual void StartFilterCallback ()
 
virtual void EndFilterCallback ()
 

Private Attributes

std::string m_Buffer
 
bool m_CoutIsConsole
 
int m_CurrentNbStars
 
int m_StarsCount
 

Additional Inherited Members

- Protected Types inherited from otb::FilterWatcherBase
typedef
itk::SimpleMemberCommand
< FilterWatcherBase
CommandType
 
- Protected Attributes inherited from otb::FilterWatcherBase
std::string m_Comment
 
bool m_Ended
 
CommandType::Pointer m_EndFilterCommand
 
unsigned long m_EndTag
 
itk::ProcessObject::Pointer m_Process
 
CommandType::Pointer m_ProgressFilterCommand
 
unsigned long m_ProgressTag
 
bool m_Started
 
CommandType::Pointer m_StartFilterCommand
 
unsigned long m_StartTag
 
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 patter Abstract class ProcessObject is the subject Event are observers

Usage example:

FilterType::Pointer thresholdFilter = FilterType::New();
StandardFilterWatcher watcher(thresholdFilter, "Threshold");
See Also
itk::SimpleFilterWatcher
otb::fltkFilterWatcher

Definition at line 52 of file otbStandardFilterWatcher.h.

Constructor & Destructor Documentation

otb::StandardFilterWatcher::StandardFilterWatcher ( 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::StandardFilterWatcher::StandardFilterWatcher ( itk::ProcessObject process,
const std::string &  comment = "" 
)
otb::StandardFilterWatcher::StandardFilterWatcher ( )
inline

Default constructor

Definition at line 65 of file otbStandardFilterWatcher.h.

otb::StandardFilterWatcher::StandardFilterWatcher ( const StandardFilterWatcher )

Copy constructor

Member Function Documentation

void otb::StandardFilterWatcher::EndFilter ( )
overrideprotectedvirtual

Callback method to show the EndEvent

Implements otb::FilterWatcherBase.

const int& otb::StandardFilterWatcher::GetStars ( ) const
inline

Get/Set number of stars

Definition at line 78 of file otbStandardFilterWatcher.h.

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

operator=

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

Get/Set number of stars

Definition at line 74 of file otbStandardFilterWatcher.h.

void otb::StandardFilterWatcher::ShowProgress ( )
overrideprotectedvirtual

Callback method to show the ProgressEvent

Implements otb::FilterWatcherBase.

void otb::StandardFilterWatcher::StartFilter ( )
overrideprotectedvirtual

Callback method to show the StartEvent

Implements otb::FilterWatcherBase.

Member Data Documentation

std::string otb::StandardFilterWatcher::m_Buffer
private

Definition at line 104 of file otbStandardFilterWatcher.h.

bool otb::StandardFilterWatcher::m_CoutIsConsole
private

Definition at line 102 of file otbStandardFilterWatcher.h.

int otb::StandardFilterWatcher::m_CurrentNbStars
private

Definition at line 100 of file otbStandardFilterWatcher.h.

int otb::StandardFilterWatcher::m_StarsCount
private

Stars coutning

Definition at line 98 of file otbStandardFilterWatcher.h.


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