Teuchos_CTimeMonitor.h File Reference

Go to the source code of this file.

Functions

int Teuchos_startTimer (char timerName[], int timerID)
 Start a timer with a given name and ID.
void Teuchos_stopTimer (int timerID)
 Stop a timer that was started with Teuchos_startTimer().

Function Documentation

int Teuchos_startTimer ( char  timerName[],
int  timerID 
)

Start a timer with a given name and ID.

Parameters:
timerName [in] Globally unique null-terminated string name of the timer. This is only significant on the first call.
timerID [in] On first call, timerID should be less than 0 On future calls, it should be what was returned by the first call.
Returns:
on first call returnVal gives the ID of a newly created timer of the given globally unique name timerName. On future calls, returnVal==timerID.
Note:
You can not start the same timer more than once. You must stop a timer with Teuchos_stopTimer() before you can call this function to start it again.

Definition at line 41 of file Teuchos_CTimeMonitor.cpp.

void Teuchos_stopTimer ( int  timerID  ) 

Stop a timer that was started with Teuchos_startTimer().

Parameters:
timerID [in] Must be the ID returned from a prior call to Teuchos_startTimer().

Preconditions:

Note:
It is okay to stop a timer more than once (i.e. stop a timer that is not running). But, the timer must actually exist.

Definition at line 68 of file Teuchos_CTimeMonitor.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:33 2011 for Teuchos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3