Class for computing the change of a value between two points in the code. More...
#include <itkResourceProbe.h>
Public Types | |
typedef unsigned long | CountType |
Public Member Functions | |
virtual ValueType | GetInstantValue (void) const =0 |
MeanType | GetMean (void) const |
CountType | GetNumberOfStarts (void) const |
CountType | GetNumberOfStops (void) const |
ValueType | GetTotal (void) const |
std::string | GetType (void) const |
std::string | GetUnit (void) const |
ResourceProbe (const std::string &type, const std::string &unit) | |
void | Start (void) |
void | Stop (void) |
virtual | ~ResourceProbe () |
Class for computing the change of a value between two points in the code.
This class is the base class of all the probes (time, memory, etc.) between the execution of two pieces of code. It can be started and stopped in order to evaluate the execution over multiple passes.
Definition at line 39 of file itkResourceProbe.h.
typedef unsigned long itk::ResourceProbe< ValueType, MeanType >::CountType |
Type for counting how many times the probe has been started and stopped.
Reimplemented in itk::TimeProbe.
Definition at line 45 of file itkResourceProbe.h.
itk::ResourceProbe< ValueType, MeanType >::ResourceProbe | ( | const std::string & | type, | |
const std::string & | unit | |||
) |
Constructor
virtual itk::ResourceProbe< ValueType, MeanType >::~ResourceProbe | ( | ) | [virtual] |
Destructor
virtual ValueType itk::ResourceProbe< ValueType, MeanType >::GetInstantValue | ( | void | ) | const [pure virtual] |
Returns the instant value of the probed system.
Implemented in itk::MemoryProbe, and itk::TimeProbe.
MeanType itk::ResourceProbe< ValueType, MeanType >::GetMean | ( | void | ) | const |
Returns the average value changes between the starts and stops of the probe. Stop() has to be called at least once, returns 0 otherwise.
CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStarts | ( | void | ) | const |
Returns the number of times that the probe has been started
CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStops | ( | void | ) | const |
Returns the number of times that the probe has been stopped
ValueType itk::ResourceProbe< ValueType, MeanType >::GetTotal | ( | void | ) | const |
Returns the accumulated value changes between the starts and stops of the probe
std::string itk::ResourceProbe< ValueType, MeanType >::GetType | ( | void | ) | const |
Returns the type probed value
std::string itk::ResourceProbe< ValueType, MeanType >::GetUnit | ( | void | ) | const |
Returns the unit probed value
void itk::ResourceProbe< ValueType, MeanType >::Start | ( | void | ) |
Start counting the change of value
Referenced by itk::SimpleFilterWatcher::StartFilter(), and itk::XMLFilterWatcher::StartFilter().
void itk::ResourceProbe< ValueType, MeanType >::Stop | ( | void | ) |
Stop counting the change of value
Referenced by itk::XMLFilterWatcher::EndFilter().