.TH "sc::Timer" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::Timer \- The \fBTimer\fP class uses \fBRegionTimer\fP to time intervals in an exception safe manner\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <regtime\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBTimer\fP (const char *name)"
.br
.RI "Start timing a region using the default \fBRegionTimer\fP and activate the timer\&. "
.ti -1c
.RI "\fBTimer\fP (const \fBRef\fP< \fBRegionTimer\fP > &, const char *name)"
.br
.RI "Start timing a region using the given \fBRegionTimer\fP\&. "
.ti -1c
.RI "\fB~Timer\fP ()"
.br
.RI "Stop timing a region, if active\&. "
.ti -1c
.RI "void \fBreset\fP (const char *=0)"
.br
.RI "Stop timing the current region, if active\&. "
.in -1c
.SH "Detailed Description"
.PP 
The \fBTimer\fP class uses \fBRegionTimer\fP to time intervals in an exception safe manner\&. 

It will automatically call RegionTimer::enter when its constructor is called and RegionTimer::exit when its destructor is called\&. The reset member can also result in \fBRegionTimer\fP's enter and exit routines being called\&. The programmer is responsible for making sure that timers are exited in the reverse of the order that they are entered\&. 
.br
 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::Timer::Timer (const char * name)"

.PP
Start timing a region using the default \fBRegionTimer\fP and activate the timer\&. If a null name pointer is given, then the timer will not be activated\&. 
.SS "sc::Timer::Timer (const \fBRef\fP< \fBRegionTimer\fP > &, const char * name)"

.PP
Start timing a region using the given \fBRegionTimer\fP\&. If a null name pointer is given, then the timer will not be activated\&. 
.SH "Member Function Documentation"
.PP 
.SS "void sc::Timer::reset (const char * = \fC0\fP)"

.PP
Stop timing the current region, if active\&. If a new region name is passed in, start timing with that name\&. If no region name is given, the \fBTimer\fP will be deactivated\&. 
.br
 

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.