Orfeo Toolbox  4.0
Public Types | Public Member Functions | Private Attributes | List of all members
itk::ResourceProbe< ValueType, MeanType > Class Template Referenceabstract

Computes the change of a value between two points in code. More...

#include <itkResourceProbe.h>

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

Public Types

typedef SizeValueType CountType
 

Public Member Functions

 ResourceProbe (const std::string &type, const std::string &unit)
 
virtual ~ResourceProbe ()
 
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
 
void Start (void)
 
void Stop (void)
 

Private Attributes

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

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.

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

Definition at line 39 of file itkResourceProbe.hxx.

References itk::NumericTraits< T >::ZeroValue().

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

Destructor

Definition at line 51 of file itkResourceProbe.hxx.

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 ( void  ) const
template<typename ValueType , typename MeanType >
ResourceProbe< ValueType, MeanType >::CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStarts ( void  ) const

Returns the number of times that the probe has been started

Get Number of Starts

Definition at line 100 of file itkResourceProbe.hxx.

template<typename ValueType , typename MeanType >
ResourceProbe< ValueType, MeanType >::CountType itk::ResourceProbe< ValueType, MeanType >::GetNumberOfStops ( void  ) const

Returns the number of times that the probe has been stopped

Get Number of Stops

Definition at line 109 of file itkResourceProbe.hxx.

template<typename ValueType , typename MeanType >
ValueType itk::ResourceProbe< ValueType, MeanType >::GetTotal ( void  ) const
template<typename ValueType , typename MeanType >
std::string itk::ResourceProbe< ValueType, MeanType >::GetType ( void  ) const

Returns the type probed value

Definition at line 58 of file itkResourceProbe.hxx.

template<typename ValueType , typename MeanType >
std::string itk::ResourceProbe< ValueType, MeanType >::GetUnit ( void  ) const

Returns the unit probed value

Definition at line 67 of file itkResourceProbe.hxx.

template<typename ValueType , typename MeanType >
void itk::ResourceProbe< ValueType, MeanType >::Start ( void  )
template<typename ValueType , typename MeanType >
void itk::ResourceProbe< ValueType, MeanType >::Stop ( void  )

Member Data Documentation

template<typename ValueType, typename MeanType>
CountType itk::ResourceProbe< ValueType, MeanType >::m_NumberOfStarts
private

Definition at line 91 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>
CountType itk::ResourceProbe< ValueType, MeanType >::m_NumberOfStops
private

Definition at line 92 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>
ValueType itk::ResourceProbe< ValueType, MeanType >::m_StartValue
private

Definition at line 88 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>
ValueType itk::ResourceProbe< ValueType, MeanType >::m_TotalValue
private

Definition at line 89 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>
std::string itk::ResourceProbe< ValueType, MeanType >::m_TypeString
private

Definition at line 94 of file itkResourceProbe.h.

template<typename ValueType, typename MeanType>
std::string itk::ResourceProbe< ValueType, MeanType >::m_UnitString
private

Definition at line 95 of file itkResourceProbe.h.


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

Generated at Sat Mar 8 2014 17:38:56 for Orfeo Toolbox with doxygen 1.8.3.1