Reference documentation for deal.II version Git 3ecc854 2017-02-27 14:34:24 -0500
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

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 397 of file timer.h.

Constructor & Destructor Documentation

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

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

Definition at line 745 of file timer.h.

TimerOutput::Scope::~Scope ( )

Destructor calls stop()

Definition at line 753 of file timer.h.

Member Function Documentation

void TimerOutput::Scope::stop ( )

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

Definition at line 760 of file timer.h.

Member Data Documentation

::TimerOutput& TimerOutput::Scope::timer

Reference to the TimerOutput object

Definition at line 421 of file timer.h.

bool TimerOutput::Scope::in

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

Definition at line 425 of file timer.h.

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