Orfeo Toolbox  3.16
Public Types | Public Member Functions | Private Attributes
itk::TimeProbe Class Reference

Class for computing the time passed between two points in the code. More...

#include <itkTimeProbe.h>

+ Inheritance diagram for itk::TimeProbe:
+ Collaboration diagram for itk::TimeProbe:

List of all members.

Public Types

typedef unsigned long CountType
typedef
RealTimeClock::TimeStampType 
TimeStampType

Public Member Functions

 TimeProbe ()
virtual ~TimeProbe ()
virtual
RealTimeClock::TimeStampType 
GetInstantValue (void) const
RealTimeClock::TimeStampType GetMean (void) const
TimeStampType GetMeanTime (void) const
CountType GetNumberOfStarts (void) const
CountType GetNumberOfStops (void) const
RealTimeClock::TimeStampType GetTotal (void) const
std::string GetType (void) const
std::string GetUnit (void) const
void Start (void)
void Stop (void)

Private Attributes

RealTimeClock::Pointer m_RealTimeClock

Detailed Description

Class for computing the time passed between two points in the code.

This class allows the user to trace the time passed between the execution of two pieces of code. It can be started and stopped in order to evaluate the execution over multiple passes. The values of time are taken from the RealTimeClock.

See also:
RealTimeClock

Definition at line 39 of file itkTimeProbe.h.


Member Typedef Documentation

typedef unsigned long itk::TimeProbe::CountType

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

Reimplemented from itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >.

Definition at line 46 of file itkTimeProbe.h.

Type for measuring time. See the RealTimeClock class for details on the precision and units of this clock signal

Definition at line 50 of file itkTimeProbe.h.


Constructor & Destructor Documentation

itk::TimeProbe::TimeProbe ( )

Constructor

Definition at line 24 of file itkTimeProbe.cxx.

References itk::RealTimeClock::New().

itk::TimeProbe::~TimeProbe ( )
virtual

Destructor

Definition at line 31 of file itkTimeProbe.cxx.


Member Function Documentation

TimeProbe::TimeStampType itk::TimeProbe::GetInstantValue ( void  ) const
virtual

Get the current time. Warning: the returned value is not the elapsed time since the last Start() call.

Implements itk::ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >.

Definition at line 45 of file itkTimeProbe.cxx.

Returns the average value changes between the starts and stops of the probe. Stop() has to be called at least once, returns 0 otherwise.

Get Mean

TimeProbe::TimeStampType itk::TimeProbe::GetMeanTime ( void  ) const
CountType itk::ResourceProbe< RealTimeClock::TimeStampType , RealTimeClock::TimeStampType >::GetNumberOfStarts ( void  ) const
inherited

Returns the number of times that the probe has been started

Get Number of Starts

Returns the number of times that the probe has been stopped

Get Number of Stops

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

Get Total

std::string itk::ResourceProbe< RealTimeClock::TimeStampType , RealTimeClock::TimeStampType >::GetType ( void  ) const
inherited

Returns the type probed value

std::string itk::ResourceProbe< RealTimeClock::TimeStampType , RealTimeClock::TimeStampType >::GetUnit ( void  ) const
inherited

Returns the unit probed value

Start counting the change of value

Start counting

Stop counting the change of value

Stop the probe


Member Data Documentation

RealTimeClock::Pointer itk::TimeProbe::m_RealTimeClock
private

Definition at line 74 of file itkTimeProbe.h.


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

Generated at Sun Feb 3 2013 02:44:04 for Orfeo Toolbox with doxygen 1.8.1.1