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 ()
	StandardFilterWatcher (const StandardFilterWatcher &)
	StandardFilterWatcher (itk::ProcessObject *process, const char *comment="")
	StandardFilterWatcher (itk::ProcessObject *process, const std::string &comment="")
Public Member Functions inherited from otb::FilterWatcherBase
	FilterWatcherBase ()
	FilterWatcherBase (const FilterWatcherBase &)
	FilterWatcherBase (itk::ProcessObject *process, const char *comment="")
std::string	GetComment ()
const char *	GetNameOfClass ()
itk::ProcessObject *	GetProcess ()
otb::Stopwatch &	GetStopwatch ()
void	operator= (const FilterWatcherBase &)
virtual	~FilterWatcherBase ()
int	m_StarsCount
int	m_CurrentNbStars
bool	m_CoutIsConsole
std::string	m_Buffer
void	SetStars (int count)
const int &	GetStars () const
void	ShowProgress () override
void	StartFilter () override
void	EndFilter () override

Additional Inherited Members
Protected Types inherited from otb::FilterWatcherBase
typedef itk::SimpleMemberCommand< FilterWatcherBase >	CommandType
Protected Member Functions inherited from otb::FilterWatcherBase
virtual void	ShowProgressCallback ()
virtual void	StartFilterCallback ()
virtual void	EndFilterCallback ()
Protected Attributes inherited from otb::FilterWatcherBase
otb::Stopwatch	m_Stopwatch
std::string	m_Comment
itk::ProcessObject::Pointer	m_Process
CommandType::Pointer	m_StartFilterCommand
CommandType::Pointer	m_EndFilterCommand
CommandType::Pointer	m_ProgressFilterCommand
unsigned long	m_StartTag
unsigned long	m_EndTag
unsigned long	m_ProgressTag
bool	m_Started
bool	m_Ended

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:

typedef itk::BinaryThresholdImageFilter<ImageType> FilterType;
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

StandardFilterWatcher() [1/4]

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.

StandardFilterWatcher() [2/4]

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

StandardFilterWatcher() [3/4]

otb::StandardFilterWatcher::StandardFilterWatcher ( )

inline

Default constructor

Definition at line 62 of file otbStandardFilterWatcher.h.

StandardFilterWatcher() [4/4]

otb::StandardFilterWatcher::StandardFilterWatcher

(

const StandardFilterWatcher &

)

Copy constructor

Member Function Documentation

EndFilter()

void otb::StandardFilterWatcher::EndFilter ( )

overrideprotectedvirtual

Callback method to show the EndEvent

Implements otb::FilterWatcherBase.

GetStars()

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

inline

Stars coutning

Definition at line 75 of file otbStandardFilterWatcher.h.

operator=()

void otb::StandardFilterWatcher::operator=

(

const StandardFilterWatcher &

)

operator=

SetStars()

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

inline

Get/Set number of stars

Definition at line 71 of file otbStandardFilterWatcher.h.

ShowProgress()

void otb::StandardFilterWatcher::ShowProgress ( )

overrideprotectedvirtual

Callback method to show the ProgressEvent

Implements otb::FilterWatcherBase.

StartFilter()

void otb::StandardFilterWatcher::StartFilter ( )

overrideprotectedvirtual

Callback method to show the StartEvent

Implements otb::FilterWatcherBase.

Member Data Documentation

m_Buffer

std::string otb::StandardFilterWatcher::m_Buffer

private

Stars coutning

Definition at line 99 of file otbStandardFilterWatcher.h.

m_CoutIsConsole

bool otb::StandardFilterWatcher::m_CoutIsConsole

private

Stars coutning

Definition at line 97 of file otbStandardFilterWatcher.h.

m_CurrentNbStars

int otb::StandardFilterWatcher::m_CurrentNbStars

private

Stars coutning

Definition at line 95 of file otbStandardFilterWatcher.h.

m_StarsCount

int otb::StandardFilterWatcher::m_StarsCount

private

Stars coutning

Definition at line 93 of file otbStandardFilterWatcher.h.

---

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

• otbStandardFilterWatcher.h