TimerOutput::Scope Class Reference

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

Detailed Description

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

Definition at line 657 of file timer.h.

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

Private Attributes
::TimerOutput &	timer
const std::string	section_name
bool	in

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 when the destructor runs.

Definition at line 1007 of file timer.h.

~Scope()

TimerOutput::Scope::~Scope

(

)

Destructor calls Scope::stop().

Definition at line 1190 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. The function leaves the current subsection of the stored TimerOutput object.

Definition at line 1019 of file timer.h.

Member Data Documentation

timer

::TimerOutput& TimerOutput::Scope::timer

private

Reference to the TimerOutput object

Definition at line 683 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 688 of file timer.h.

in

bool TimerOutput::Scope::in

private

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

Definition at line 693 of file timer.h.

---

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

• include/deal.II/base/timer.h
• source/base/timer.cc