otb::StandardWriterWatcher Class Reference

#include <otbStandardWriterWatcher.h>

Inheritance diagram for otb::StandardWriterWatcher:

Collaboration diagram for otb::StandardWriterWatcher:

unsigned int	m_StarsCount
bool	m_CoutIsConsole
std::string	m_Buffer
	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 &)
void	operator= (const StandardWriterWatcher &)
void	SetStars (int count)
const unsigned int &	GetStars () const
void	ShowWriterProgress () override
void	StartWriter () override
void	EndWriter () override
void	ShowFilterProgress () override
void	StartFilter () override
void	EndFilter () override
virtual void	ShowProgress ()

Additional Inherited Members
Public Member Functions inherited from otb::WriterWatcherBase
std::string	GetComment () const
const char *	GetNameOfClass ()
itk::ProcessObject *	GetProcess ()
otb::Stopwatch &	GetStopwatch ()
void	operator= (const WriterWatcherBase &)
	WriterWatcherBase ()
	WriterWatcherBase (const WriterWatcherBase &)
	WriterWatcherBase (itk::ProcessObject *process, const char *comment="")
	WriterWatcherBase (itk::ProcessObject *process, itk::ProcessObject *source, const char *comment="")
virtual	~WriterWatcherBase ()
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

StandardWriterWatcher() [1/6]

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.

StandardWriterWatcher() [2/6]

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

Stars coutning

StandardWriterWatcher() [3/6]

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

Stars coutning

StandardWriterWatcher() [4/6]

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

Stars coutning

StandardWriterWatcher() [5/6]

otb::StandardWriterWatcher::StandardWriterWatcher ( )

inline

Default constructor

Definition at line 69 of file otbStandardWriterWatcher.h.

StandardWriterWatcher() [6/6]

otb::StandardWriterWatcher::StandardWriterWatcher

(

const StandardWriterWatcher &

)

Copy constructor

Member Function Documentation

EndFilter()

void otb::StandardWriterWatcher::EndFilter ( )

inlineoverrideprotectedvirtual

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

Definition at line 107 of file otbStandardWriterWatcher.h.

EndWriter()

void otb::StandardWriterWatcher::EndWriter ( )

overrideprotectedvirtual

Callback method to show the EndEvent

Implements otb::WriterWatcherBase.

GetStars()

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

inline

Stars coutning

Definition at line 82 of file otbStandardWriterWatcher.h.

operator=()

void otb::StandardWriterWatcher::operator=

(

const StandardWriterWatcher &

)

operator=

SetStars()

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

inline

Get/Set number of stars

Definition at line 78 of file otbStandardWriterWatcher.h.

ShowFilterProgress()

void otb::StandardWriterWatcher::ShowFilterProgress ( )

overrideprotectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

ShowProgress()

virtual void otb::StandardWriterWatcher::ShowProgress ( )

protectedvirtual

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

ShowWriterProgress()

void otb::StandardWriterWatcher::ShowWriterProgress ( )

overrideprotectedvirtual

Callback method to show the ProgressEvent

Implements otb::WriterWatcherBase.

StartFilter()

void otb::StandardWriterWatcher::StartFilter ( )

inlineoverrideprotectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Definition at line 102 of file otbStandardWriterWatcher.h.

StartWriter()

void otb::StandardWriterWatcher::StartWriter ( )

overrideprotectedvirtual

Callback method to show the StartEvent

Implements otb::WriterWatcherBase.

Member Data Documentation

m_Buffer

std::string otb::StandardWriterWatcher::m_Buffer

private

Stars coutning

Definition at line 120 of file otbStandardWriterWatcher.h.

m_CoutIsConsole

bool otb::StandardWriterWatcher::m_CoutIsConsole

private

Stars coutning

Definition at line 118 of file otbStandardWriterWatcher.h.

m_StarsCount

unsigned int otb::StandardWriterWatcher::m_StarsCount

private

Stars coutning

Definition at line 116 of file otbStandardWriterWatcher.h.

---

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

• otbStandardWriterWatcher.h