Teuchos::Time Class Reference

Basic wall-clock timer class. More...

#include <Teuchos_Time.hpp>

List of all members.

Public Member Functions

 Time (const std::string &name, bool start=false)
 Construct with a descriptive name.
void start (bool reset=false)
 Starts the timer.
double stop ()
 Stops the timer.
double totalElapsedTime (bool readCurrentTime=false) const
 Returns the total time (in seconds) accumulated by this timer.
void reset ()
 Resets the cummulative time and number of times this timer has been called. Does not affect any other state.
bool isRunning () const
 Indicates if this timer is currently running, i.e., if it has been started but not yet stopped.
const std::string & name () const
 Return the name of this timer.
void incrementNumCalls ()
 Increment the number of times this timer has been called.
int numCalls () const
 Return the number of times this timer has been called.

Static Public Member Functions

static double wallTime ()
 Returns current wall-clock time in seconds.

Detailed Description

Basic wall-clock timer class.

To time a section of code, place it in between calls to start() and stop().

Note:
For std::exception safety and correct behavior in reentrant code, this class should generally be used only through the Teuchos::TimeMonitor mechanism.

Definition at line 80 of file Teuchos_Time.hpp.


Constructor & Destructor Documentation

Teuchos::Time::Time ( const std::string &  name,
bool  start = false 
)

Construct with a descriptive name.

Definition at line 65 of file Teuchos_Time.cpp.


Member Function Documentation

double Teuchos::Time::wallTime (  )  [static]

Returns current wall-clock time in seconds.

Definition at line 96 of file Teuchos_Time.cpp.

void Teuchos::Time::start ( bool  reset = false  ) 

Starts the timer.

Definition at line 71 of file Teuchos_Time.cpp.

double Teuchos::Time::stop (  ) 

Stops the timer.

Definition at line 78 of file Teuchos_Time.cpp.

double Teuchos::Time::totalElapsedTime ( bool  readCurrentTime = false  )  const

Returns the total time (in seconds) accumulated by this timer.

This should be called only when the clock is stopped.

Definition at line 88 of file Teuchos_Time.cpp.

void Teuchos::Time::reset (  )  [inline]

Resets the cummulative time and number of times this timer has been called. Does not affect any other state.

Definition at line 103 of file Teuchos_Time.hpp.

bool Teuchos::Time::isRunning (  )  const [inline]

Indicates if this timer is currently running, i.e., if it has been started but not yet stopped.

It is necessary to know if a timer is running to avoid incorrectly starting or stopping in reentrant code.

Definition at line 110 of file Teuchos_Time.hpp.

const std::string& Teuchos::Time::name (  )  const [inline]

Return the name of this timer.

Definition at line 113 of file Teuchos_Time.hpp.

void Teuchos::Time::incrementNumCalls (  )  [inline]

Increment the number of times this timer has been called.

Definition at line 116 of file Teuchos_Time.hpp.

int Teuchos::Time::numCalls (  )  const [inline]

Return the number of times this timer has been called.

Definition at line 119 of file Teuchos_Time.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:47 2011 for Teuchos - Trilinos Tools Package by  doxygen 1.6.3