Public Member Functions | List of all members
STimerScoped_< TimerType > Class Template Reference

#include <stattimer.hpp>

+ Collaboration diagram for STimerScoped_< TimerType >:

Public Member Functions

 STimerScoped_ (STimerList_< TimerType > &stlist, int i)
 
 STimerScoped_ (STimerList_< TimerType > &stlist, const char *label)
 
 ~STimerScoped_ ()
 

Detailed Description

template<typename TimerType>
class STimerScoped_< TimerType >

Class for a scoped timer object. It makes a specified timer to measure the elapsed time between the time when it is constructed and the time when it is destructed.

This is designed as a template class just for testability (i.e. to cope with a mock subclass of STimer). Users should always use STimerScoped, which is typedef of STimerScoped_<STimer>.

Definition at line 71 of file stattimer.hpp.

Constructor & Destructor Documentation

§ STimerScoped_() [1/2]

template<typename TimerType >
STimerScoped_< TimerType >::STimerScoped_ ( STimerList_< TimerType > &  stlist,
int  i 
)
inline

Constructor that starts the timer i in the STimerList stlist.

Parameters
stlist[in] STimerList that contains the timer to be used
i[in] Timer id

Definition at line 585 of file stattimer.hpp.

§ STimerScoped_() [2/2]

template<typename TimerType >
STimerScoped_< TimerType >::STimerScoped_ ( STimerList_< TimerType > &  stlist,
const char *  label 
)
inline

Constructor that starts the timer with specified label in the STimerList stlist.

Parameters
stlist[in] STimerList that contains the timer to be used
label[in] Timer label

Definition at line 595 of file stattimer.hpp.

§ ~STimerScoped_()

template<typename TimerType >
STimerScoped_< TimerType >::~STimerScoped_ ( )
inline

Destructor in which the timer is stopped.

Definition at line 602 of file stattimer.hpp.


The documentation for this class was generated from the following file: