itk::XMLFilterWatcher Class Reference

Simple mechanism for monitoring the pipeline events of a filter and reporting these events to std::cout. Formats reports with xml. More...

#include <itkXMLFilterWatcher.h>

Inheritance diagram for itk::XMLFilterWatcher:

Collaboration diagram for itk::XMLFilterWatcher:

List of all members.

Public Member Functions
	XMLFilterWatcher (ProcessObject *o, const char *comment="")
std::string	GetComment ()
int	GetIterations ()
const char *	GetNameOfClass ()
ProcessObject *	GetProcess ()
bool	GetQuiet ()
int	GetSteps ()
TimeProbe &	GetTimeProbe ()
void	QuietOff ()
void	QuietOn ()
void	SetIterations (int val)
void	SetQuiet (bool val)
void	SetSteps (int val)
void	TestAbortOff ()
void	TestAbortOn ()

Protected Member Functions
virtual void	EndFilter ()
virtual void	ShowAbort ()
virtual void	ShowIteration ()
virtual void	ShowProgress ()
virtual void	StartFilter ()

---

Detailed Description

Simple mechanism for monitoring the pipeline events of a filter and reporting these events to std::cout. Formats reports with xml.

Definition at line 30 of file itkXMLFilterWatcher.h.

---

Constructor & Destructor Documentation

itk::XMLFilterWatcher::XMLFilterWatcher ( ProcessObject *  o, const char *  comment = ""  )

inline

Definition at line 33 of file itkXMLFilterWatcher.h.

---

Member Function Documentation

virtual void itk::XMLFilterWatcher::EndFilter ( )

inlineprotectedvirtual

Callback method to show the EndEvent

Reimplemented from itk::SimpleFilterWatcher.

Definition at line 83 of file itkXMLFilterWatcher.h.

References itk::TimeProbe::GetMeanTime(), itk::ProcessObject::GetNameOfClass(), itk::SimpleFilterWatcher::GetProcess(), itk::SimpleFilterWatcher::GetQuiet(), itk::SimpleFilterWatcher::GetTimeProbe(), and itk::ResourceProbe< ValueType, MeanType >::Stop().

std::string itk::SimpleFilterWatcher::GetComment ( )

inlineinherited

Get the comment for the watcher.

Definition at line 120 of file itkSimpleFilterWatcher.h.

Referenced by StartFilter().

int itk::SimpleFilterWatcher::GetIterations ( )

inlineinherited

Definition at line 112 of file itkSimpleFilterWatcher.h.

const char* itk::SimpleFilterWatcher::GetNameOfClass ( )

inlineinherited

Method to get the name of the class be monitored by this SimpleFilterWatcher

Definition at line 86 of file itkSimpleFilterWatcher.h.

ProcessObject* itk::SimpleFilterWatcher::GetProcess ( )

inlineinherited

Methods to access member data Get a pointer to the process object being watched.

Definition at line 104 of file itkSimpleFilterWatcher.h.

Referenced by EndFilter(), ShowProgress(), and StartFilter().

bool itk::SimpleFilterWatcher::GetQuiet ( )

inlineinherited

Definition at line 117 of file itkSimpleFilterWatcher.h.

Referenced by EndFilter(), ShowProgress(), and StartFilter().

int itk::SimpleFilterWatcher::GetSteps ( )

inlineinherited

Definition at line 108 of file itkSimpleFilterWatcher.h.

Referenced by ShowProgress().

TimeProbe& itk::SimpleFilterWatcher::GetTimeProbe ( )

inlineinherited

Get a reference to the TimeProbe

Definition at line 123 of file itkSimpleFilterWatcher.h.

Referenced by EndFilter(), and StartFilter().

void itk::SimpleFilterWatcher::QuietOff ( )

inlineinherited

Definition at line 94 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::QuietOn ( )

inlineinherited

Methods to control the verbosity of the messages. Quiet reporting limits the information emitted at a ProgressEvent.

Definition at line 93 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::SetIterations ( int  val )

inlineinherited

Set/Get the number of iterations completed.

Definition at line 111 of file itkSimpleFilterWatcher.h.

Referenced by StartFilter().

void itk::SimpleFilterWatcher::SetQuiet ( bool  val )

inlineinherited

Set/Get the quiet mode boolean. If true, verbose progress is reported.

Definition at line 116 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::SetSteps ( int  val )

inlineinherited

Set/Get the steps completed.

Definition at line 107 of file itkSimpleFilterWatcher.h.

Referenced by ShowProgress(), and StartFilter().

virtual void itk::SimpleFilterWatcher::ShowAbort ( )

inlineprotectedvirtualinherited

Callback method to show the AbortEvent

Definition at line 152 of file itkSimpleFilterWatcher.h.

Referenced by itk::SimpleFilterWatcher::operator=(), and itk::SimpleFilterWatcher::SimpleFilterWatcher().

virtual void itk::SimpleFilterWatcher::ShowIteration ( )

inlineprotectedvirtualinherited

Callback method to show the IterationEvent

Definition at line 158 of file itkSimpleFilterWatcher.h.

Referenced by itk::SimpleFilterWatcher::operator=(), and itk::SimpleFilterWatcher::SimpleFilterWatcher().

virtual void itk::XMLFilterWatcher::ShowProgress ( )

inlineprotectedvirtual

Callback method to show the ProgressEvent

Reimplemented from itk::SimpleFilterWatcher.

Definition at line 39 of file itkXMLFilterWatcher.h.

References itk::SimpleFilterWatcher::GetProcess(), itk::ProcessObject::GetProgress(), itk::SimpleFilterWatcher::GetQuiet(), itk::SimpleFilterWatcher::GetSteps(), and itk::SimpleFilterWatcher::SetSteps().

virtual void itk::XMLFilterWatcher::StartFilter ( )

inlineprotectedvirtual

Callback method to show the StartEvent

Reimplemented from itk::SimpleFilterWatcher.

Definition at line 58 of file itkXMLFilterWatcher.h.

References itk::SimpleFilterWatcher::GetComment(), itk::ProcessObject::GetNameOfClass(), itk::SimpleFilterWatcher::GetProcess(), itk::SimpleFilterWatcher::GetQuiet(), itk::SimpleFilterWatcher::GetTimeProbe(), itk::SimpleFilterWatcher::SetIterations(), itk::SimpleFilterWatcher::SetSteps(), and itk::ResourceProbe< ValueType, MeanType >::Start().

void itk::SimpleFilterWatcher::TestAbortOff ( )

inlineinherited

Definition at line 100 of file itkSimpleFilterWatcher.h.

void itk::SimpleFilterWatcher::TestAbortOn ( )

inlineinherited

Methods to use to test the AbortEvent of the a filter. If TestAbort is on, the filter being watched will be aborted when the progress reaches 30%.

Definition at line 99 of file itkSimpleFilterWatcher.h.

---

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

• itkXMLFilterWatcher.h