Reference documentation for deal.II version Git e051263625 2020-04-08 22:32:15 +0200
\(\newcommand{\vcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\vcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
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 554 of file timer.h.

Constructor & Destructor Documentation

◆ Scope()

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

◆ ~Scope()

TimerOutput::Scope::~Scope ( )

Destructor calls stop()

Definition at line 1043 of file timer.cc.

Member Function Documentation

◆ stop()

void TimerOutput::Scope::stop ( )
inline

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

Definition at line 984 of file timer.h.

Member Data Documentation

◆ timer

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

Reference to the TimerOutput object

Definition at line 579 of file timer.h.

◆ section_name

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

Name of the section we need to exit

Definition at line 584 of file timer.h.

◆ in

bool TimerOutput::Scope::in
private

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

Definition at line 589 of file timer.h.


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