Orfeo Toolbox  4.0
Public Member Functions | Protected Member Functions | List of all members
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:

Public Member Functions

 XMLFilterWatcher (ProcessObject *o, const char *comment="")
 
std::string GetComment ()
 
int GetIterations ()
 
const char * GetNameOfClass ()
 
ProcessObjectGetProcess ()
 
bool GetQuiet ()
 
int GetSteps ()
 
TimeProbeGetTimeProbe ()
 
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 31 of file itkXMLFilterWatcher.h.

Constructor & Destructor Documentation

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

Definition at line 34 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 84 of file itkXMLFilterWatcher.h.

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

Get the comment for the watcher.

Definition at line 123 of file itkSimpleFilterWatcher.h.

Referenced by StartFilter().

int itk::SimpleFilterWatcher::GetIterations ( )
inlineinherited

Definition at line 115 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 89 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 107 of file itkSimpleFilterWatcher.h.

Referenced by ShowProgress(), and StartFilter().

bool itk::SimpleFilterWatcher::GetQuiet ( )
inlineinherited

Definition at line 120 of file itkSimpleFilterWatcher.h.

Referenced by ShowProgress(), and StartFilter().

int itk::SimpleFilterWatcher::GetSteps ( )
inlineinherited

Definition at line 111 of file itkSimpleFilterWatcher.h.

Referenced by ShowProgress().

TimeProbe& itk::SimpleFilterWatcher::GetTimeProbe ( )
inlineinherited

Get a reference to the TimeProbe

Definition at line 126 of file itkSimpleFilterWatcher.h.

Referenced by StartFilter().

void itk::SimpleFilterWatcher::QuietOff ( )
inlineinherited

Definition at line 97 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 96 of file itkSimpleFilterWatcher.h.

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

Set/Get the number of iterations completed.

Definition at line 114 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 119 of file itkSimpleFilterWatcher.h.

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

Set/Get the steps completed.

Definition at line 110 of file itkSimpleFilterWatcher.h.

Referenced by ShowProgress(), and StartFilter().

virtual void itk::SimpleFilterWatcher::ShowAbort ( )
inlineprotectedvirtualinherited

Callback method to show the AbortEvent

Definition at line 155 of file itkSimpleFilterWatcher.h.

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

virtual void itk::SimpleFilterWatcher::ShowIteration ( )
inlineprotectedvirtualinherited
virtual void itk::XMLFilterWatcher::ShowProgress ( )
inlineprotectedvirtual
virtual void itk::XMLFilterWatcher::StartFilter ( )
inlineprotectedvirtual
void itk::SimpleFilterWatcher::TestAbortOff ( )
inlineinherited

Definition at line 103 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 102 of file itkSimpleFilterWatcher.h.


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

Generated at Sat Mar 8 2014 18:01:38 for Orfeo Toolbox with doxygen 1.8.3.1