PerfGuard Class Reference

Scope guard for starting and stopping timing for a node. More...

#include <PerfGuard.h>

Public Member Functions
	PerfGuard (PerfGraph &graph, const PerfID id)
	Start timing for the given ID. More...
	~PerfGuard ()
	Stop timing. More...

Protected Attributes
PerfGraph &	_graph
	The graph we're working on. More...

Detailed Description

Scope guard for starting and stopping timing for a node.

Note that the PerfGuard timing itself will take approximately 0.00015 milliseconds.

That might not sound very long - but you still don't want that in the inside of tiny loops

Definition at line 24 of file PerfGuard.h.

Constructor & Destructor Documentation

PerfGuard()

PerfGuard::PerfGuard ( PerfGraph &  graph, const PerfID  id  )

inline

Start timing for the given ID.

Parameters

graph	The graph to add time into
id	The unique id of the section

Definition at line 33 of file PerfGuard.h.

: _graph(graph) { _graph.push(id); }

~PerfGuard()

PerfGuard::~PerfGuard ( )

inline

Stop timing.

Definition at line 38 of file PerfGuard.h.

{ _graph.pop(); }

Member Data Documentation

_graph

PerfGraph& PerfGuard::_graph

protected

The graph we're working on.

Definition at line 42 of file PerfGuard.h.

Referenced by PerfGuard(), and ~PerfGuard().

---

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

• include/utils/PerfGuard.h