Reference documentation for deal.II version Git 4a2ac69 2017-09-19 13:41:17 -0400
Public Member Functions | Private Attributes | List of all members
TimerOutput::Scope Class Reference

#include <deal.II/base/timer.h>

Public Member Functions

 Scope (::TimerOutput &timer_, const std::string &section_name)
 
 ~Scope ()
 
void stop ()
 

Private Attributes

::TimerOutputtimer
 
const std::string section_name
 
bool in
 

Detailed Description

Helper class to enter/exit sections in TimerOutput be constructing a simple scope-based object. The purpose of this class is explained in the documentation of TimerOutput.

Definition at line 564 of file timer.h.

Constructor & Destructor Documentation

TimerOutput::Scope::Scope ( ::TimerOutput timer_,
const std::string &  section_name 
)
inline

Enter the given section in the timer. Exit automatically when calling stop() or destructor runs.

Definition at line 990 of file timer.h.

TimerOutput::Scope::~Scope ( )
inline

Destructor calls stop()

Definition at line 1001 of file timer.h.

Member Function Documentation

void TimerOutput::Scope::stop ( )
inline

In case you want to exit the scope before the destructor is executed, call this function.

Definition at line 1013 of file timer.h.

Member Data Documentation

::TimerOutput& TimerOutput::Scope::timer
private

Reference to the TimerOutput object

Definition at line 588 of file timer.h.

const std::string TimerOutput::Scope::section_name
private

Name of the section we need to exit

Definition at line 593 of file timer.h.

bool TimerOutput::Scope::in
private

Do we still need to exit the section we are in?

Definition at line 598 of file timer.h.


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