itk::ResourceProbe< ValueType, MeanType > Class Template Reference

#include <itkResourceProbe.h>

Inheritance diagram for itk::ResourceProbe< ValueType, MeanType >:

Collaboration diagram for itk::ResourceProbe< ValueType, MeanType >:

Detailed Description

template<typename ValueType, typename MeanType>
class itk::ResourceProbe< ValueType, MeanType >

Computes the change of a value between two points in 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.

See Also

TimeResourceProbe, MemoryResourceProbe

Definition at line 39 of file itkResourceProbe.h.

Public Types
typedef SizeValueType	CountType

Public Member Functions
virtual ValueType	GetInstantValue (void) const =0
MeanType	GetMean () const
CountType	GetNumberOfStarts () const
CountType	GetNumberOfStops () const
ValueType	GetTotal () const
std::string	GetType () const
std::string	GetUnit () const
void	Reset ()
	ResourceProbe (const std::string &type, const std::string &unit)
void	Start ()
void	Stop ()
virtual	~ResourceProbe ()

Private Attributes
CountType	m_NumberOfStarts
CountType	m_NumberOfStops
ValueType	m_StartValue
ValueType	m_TotalValue
std::string	m_TypeString
std::string	m_UnitString

Member Typedef Documentation

template<typename ValueType, typename MeanType>

typedef SizeValueType itk::ResourceProbe< ValueType, MeanType >::CountType

Type for counting how many times the probe has been started and stopped.

Definition at line 45 of file itkResourceProbe.h.

Constructor & Destructor Documentation

template<typename ValueType, typename MeanType>

itk::ResourceProbe< ValueType, MeanType >::ResourceProbe	(	const std::string &	type,
		const std::string &	unit
	)

Constructor

template<typename ValueType, typename MeanType>

virtual itk::ResourceProbe< ValueType, MeanType >::~ResourceProbe ( )

virtual

Destructor

Member Function Documentation

template<typename ValueType, typename MeanType>

virtual ValueType itk::ResourceProbe< ValueType, MeanType >::GetInstantValue ( void  ) const

pure virtual

Returns the instant value of the probed system.

Implemented in itk::TimeProbe, and itk::MemoryProbe.

template<typename ValueType, typename MeanType>

MeanType itk::ResourceProbe< ValueType, MeanType >::GetMean

(

)

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.

template<typename ValueType, typename MeanType>

CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStarts

(

)

const

Returns the number of times that the probe has been started

template<typename ValueType, typename MeanType>

CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStops

(

)

const

Returns the number of times that the probe has been stopped

template<typename ValueType, typename MeanType>

ValueType itk::ResourceProbe< ValueType, MeanType >::GetTotal

(

)

const

Returns the accumulated value changes between the starts and stops of the probe

template<typename ValueType, typename MeanType>

std::string itk::ResourceProbe< ValueType, MeanType >::GetType

(

)

const

Returns the type probed value

template<typename ValueType, typename MeanType>

std::string itk::ResourceProbe< ValueType, MeanType >::GetUnit

(

)

const

Returns the unit probed value

template<typename ValueType, typename MeanType>

void itk::ResourceProbe< ValueType, MeanType >::Reset

(

)

Reset the probe

template<typename ValueType, typename MeanType>

void itk::ResourceProbe< ValueType, MeanType >::Start

(

)

Start counting the change of value

template<typename ValueType, typename MeanType>

void itk::ResourceProbe< ValueType, MeanType >::Stop

(

)

Stop counting the change of value.

If a matching Start() has not been called before, there is no effect.

Member Data Documentation

template<typename ValueType, typename MeanType>

CountType itk::ResourceProbe< ValueType, MeanType >::m_NumberOfStarts

private

Definition at line 98 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>

CountType itk::ResourceProbe< ValueType, MeanType >::m_NumberOfStops

private

Definition at line 99 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>

ValueType itk::ResourceProbe< ValueType, MeanType >::m_StartValue

private

Definition at line 95 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>

ValueType itk::ResourceProbe< ValueType, MeanType >::m_TotalValue

private

Definition at line 96 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>

std::string itk::ResourceProbe< ValueType, MeanType >::m_TypeString

private

Definition at line 101 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>

std::string itk::ResourceProbe< ValueType, MeanType >::m_UnitString

private

Definition at line 102 of file itkResourceProbe.h.

---

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

• itkResourceProbe.h