IT++ Logo Newcom Logo

itpp::Timer Class Reference
[Timers]

A virtual base class for timers. More...

#include <itpp/base/timing.h>

Inheritance diagram for itpp::Timer:

itpp::CPU_Timer itpp::Real_Timer List of all members.

Public Member Functions

 Timer ()
 Create a new timer. Sets the time to zero.
virtual ~Timer ()
 Virtual destructor.
void start (void)
 Start the timer. This does not set the time to zero.
double stop (void)
 Stop the timer. Returns the elapsed time in seconds.
void reset (double t=0.0)
 Sets the time to time t, which is zero by default. Stops the timer if it is running.
void tic (void)
 Resets the timer and starts it.
double toc (void)
 Returns the elapsed time since last tic().
void toc_print (void)
 Prints the elapsed time since last tic().
double get_time () const
 Returns the elapsed time.

Protected Member Functions

virtual double get_current_time () const=0
 Vitrual function that returns teh current time.

Protected Attributes

double start_time
 The start time of the timer.
double stop_time
 The stop time of the timer.
double elapsed_time
 The ellapsed time from start to stop.
bool running
 A bool that indicates if the timer is running or not.

Detailed Description

A virtual base class for timers.

Definition at line 47 of file timing.h.


Constructor & Destructor Documentation

itpp::Timer::Timer (  ) 

Create a new timer. Sets the time to zero.

Definition at line 82 of file timing.cpp.

References reset().

virtual itpp::Timer::~Timer (  )  [inline, virtual]

Virtual destructor.

Definition at line 52 of file timing.h.


Member Function Documentation

void itpp::Timer::start ( void   ) 

Start the timer. This does not set the time to zero.

Definition at line 87 of file timing.cpp.

References get_current_time(), running, and start_time.

Referenced by itpp::pause(), and tic().

double itpp::Timer::stop ( void   ) 

Stop the timer. Returns the elapsed time in seconds.

Definition at line 95 of file timing.cpp.

References elapsed_time, get_current_time(), running, start_time, and stop_time.

void itpp::Timer::reset ( double  t = 0.0  ) 

Sets the time to time t, which is zero by default. Stops the timer if it is running.

Definition at line 106 of file timing.cpp.

References elapsed_time, running, start_time, and stop_time.

Referenced by tic(), and Timer().

void itpp::Timer::tic ( void   ) 

Resets the timer and starts it.

Definition at line 121 of file timing.cpp.

References reset(), and start().

Referenced by itpp::tic().

double itpp::Timer::toc ( void   ) 

Returns the elapsed time since last tic().

Definition at line 127 of file timing.cpp.

References get_time().

Referenced by itpp::toc().

void itpp::Timer::toc_print ( void   ) 

Prints the elapsed time since last tic().

Definition at line 132 of file timing.cpp.

References get_time().

Referenced by itpp::toc_print().

double itpp::Timer::get_time (  )  const

Returns the elapsed time.

Definition at line 114 of file timing.cpp.

References elapsed_time, get_current_time(), running, and start_time.

Referenced by itpp::pause(), toc(), and toc_print().

virtual double itpp::Timer::get_current_time (  )  const [protected, pure virtual]

Vitrual function that returns teh current time.

Implemented in itpp::CPU_Timer, and itpp::Real_Timer.

Referenced by get_time(), start(), and stop().


Member Data Documentation

double itpp::Timer::start_time [protected]

The start time of the timer.

Definition at line 72 of file timing.h.

Referenced by get_time(), reset(), start(), and stop().

double itpp::Timer::stop_time [protected]

The stop time of the timer.

Definition at line 74 of file timing.h.

Referenced by reset(), and stop().

double itpp::Timer::elapsed_time [protected]

The ellapsed time from start to stop.

Definition at line 76 of file timing.h.

Referenced by get_time(), reset(), and stop().

bool itpp::Timer::running [protected]

A bool that indicates if the timer is running or not.

Definition at line 78 of file timing.h.

Referenced by get_time(), reset(), start(), and stop().


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

Generated on Wed Apr 18 11:20:03 2007 for IT++ by Doxygen 1.5.2