Teuchos_CTimeMonitor.h File Reference

This graph shows which files directly or indirectly include this file:

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. More...
void	Teuchos_stopTimer (int timerID)
	Stop a timer that was started with Teuchos_startTimer(). More...

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

• timerID >= 0 and it must have been created by a prior call to Teuchos_startTimer().

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 63 of file Teuchos_CTimeMonitor.cpp.