itk::TimeProbe Class Reference

#include <itkTimeProbe.h>

Collaboration diagram for itk::TimeProbe:

[legend]List of all members.

---

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 38 of file itkTimeProbe.h.

Public Types
typedef unsigned long	CountType
typedef RealTimeClock::TimeStampType	TimeStampType
Public Member Functions
TimeStampType	GetMeanTime (void) const
CountType	GetNumberOfStarts (void) const
CountType	GetNumberOfStops (void) const
void	Start (void)
void	Stop (void)
	TimeProbe ()
	~TimeProbe ()

---

Member Typedef Documentation

typedef unsigned long itk::TimeProbe::CountType

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

Definition at line 44 of file itkTimeProbe.h.

typedef RealTimeClock::TimeStampType itk::TimeProbe::TimeStampType

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

Definition at line 48 of file itkTimeProbe.h.

---

Constructor & Destructor Documentation

itk::TimeProbe::TimeProbe

(

)

Constructor

itk::TimeProbe::~TimeProbe

(

)

Destructor

---

Member Function Documentation

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.

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

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

CountType itk::TimeProbe::GetNumberOfStarts

(

void

)

const

Returns the number of times that the probe has been started.

CountType itk::TimeProbe::GetNumberOfStops

(

void

)

const

Returns the number of times that the probe has been stopped.

void itk::TimeProbe::Start

(

void

)

Start counting the time

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

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

void itk::TimeProbe::Stop

(

void

)

Stop counting the time

Examples:

Testing/Code/Common/itkVectorImageTest.cxx.

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

---

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

• itkTimeProbe.h

---