Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions

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:
Inheritance graph
[legend]
Collaboration diagram for itk::TimeProbe:
Collaboration graph
[legend]

List of all members.

Public Types

typedef unsigned long CountType
typedef
RealTimeClock::TimeStampType 
TimeStampType

Public Member Functions

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)
 TimeProbe ()
virtual ~TimeProbe ()

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
Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

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

virtual itk::TimeProbe::~TimeProbe (  )  [virtual]

Destructor


Member Function Documentation

virtual RealTimeClock::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 >.

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

TimeStampType itk::TimeProbe::GetMeanTime ( void   )  const

Returns the average times passed between the starts and stops of the probe. See the RealTimeClock for details on the precision and units of this time value. Obsolete method kept for backward compatibility, use Probe::GetMean() instead.

Deprecated:
Examples:
Testing/Code/Common/itkVectorImageTest.cxx.

Referenced by itk::XMLFilterWatcher::EndFilter().

CountType itk::ResourceProbe< RealTimeClock::TimeStampType , RealTimeClock::TimeStampType >::GetNumberOfStarts ( void   )  const [inherited]

Returns the number of times that the probe has been started

CountType itk::ResourceProbe< RealTimeClock::TimeStampType , RealTimeClock::TimeStampType >::GetNumberOfStops ( void   )  const [inherited]

Returns the number of times that the probe has been stopped

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

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

Examples:
Testing/Code/Common/itkVectorImageTest.cxx.

Stop counting the change of value

Examples:
Testing/Code/Common/itkVectorImageTest.cxx.

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

Generated at Tue Jul 13 2010 02:49:56 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000