A simple RAII class to measure the time of an operation. More...

#include <profile.h>

Inheritance diagram for SCOPED_PROF_TIMER< DURATION >:

Public Member Functions
	SCOPED_PROF_TIMER (DURATION &aDuration)

	~SCOPED_PROF_TIMER ()

void	Start ()
	Start or restart the counter.

void	Stop ()
	Save the time when this function was called, and set the counter stane to stop.

void	Show (std::ostream &aStream=std::cerr)
	Print the elapsed time (in a suitable unit) to a stream.

template<typename DURATION >
DURATION	SinceStart (bool aSinceLast=false)

double	msecs (bool aSinceLast=false)

std::string	to_string ()

Private Types
using	CLOCK = std::chrono::high_resolution_clock

using	TIME_POINT = std::chrono::time_point< CLOCK >

Private Attributes
PROF_TIMER	m_counter
	< The counter to use to do the profiling

DURATION &	m_duration

std::string	m_name

bool	m_running

TIME_POINT	m_starttime

TIME_POINT	m_lasttime

TIME_POINT	m_stoptime

Detailed Description

template<typename DURATION>
class SCOPED_PROF_TIMER< DURATION >

A simple RAII class to measure the time of an operation.

On construction, a timer is started, and on destruction, the timer is ended, and the time difference is written into the given duration.

For example:

DURATION duration; // select a duration type as needed { SCOPED_PROF_TIMER<DURATION> timer( duration ); timed_activity(); } // duration is now the time timed activity took

From C++17, with class template argument deduction, you should be able to omit the <DURATION>.

Definition at line 212 of file profile.h.

Member Typedef Documentation

◆ CLOCK

using PROF_TIMER::CLOCK = std::chrono::high_resolution_clock

privateinherited

Definition at line 186 of file profile.h.

◆ TIME_POINT

using PROF_TIMER::TIME_POINT = std::chrono::time_point<CLOCK>

privateinherited

Definition at line 187 of file profile.h.

Constructor & Destructor Documentation

◆ SCOPED_PROF_TIMER()

template<typename DURATION >

SCOPED_PROF_TIMER< DURATION >::SCOPED_PROF_TIMER ( DURATION & aDuration )

inline

Definition at line 215 of file profile.h.

◆ ~SCOPED_PROF_TIMER()

template<typename DURATION >

SCOPED_PROF_TIMER< DURATION >::~SCOPED_PROF_TIMER ( )

inline

Definition at line 219 of file profile.h.

References SCOPED_PROF_TIMER< DURATION >::m_counter, SCOPED_PROF_TIMER< DURATION >::m_duration, and PROF_TIMER::SinceStart().

Member Function Documentation

◆ msecs()

double PROF_TIMER::msecs ( bool aSinceLast = false )

inlineinherited

Parameters

aSinceLast only get the time since the last time the time was read.

Returns: the elapsed time in ms since the timer was started.

Definition at line 149 of file profile.h.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), KIGFX::GPU_NONCACHED_MANAGER::EndDrawing(), GetNodeCount(), SCH_EDIT_FRAME::RecalculateConnections(), KIGFX::VIEW::Redraw(), DATABASE_CONNECTION::selectAllAndCache(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), and DATABASE_CONNECTION::SelectOne().

◆ Show()

void PROF_TIMER::Show ( std::ostream & aStream = std::cerr )

inlineinherited

Print the elapsed time (in a suitable unit) to a stream.

The unit is automatically chosen from ns, us, ms and s, depending on the size of the current count.

Parameters

the	stream to print to.

Definition at line 105 of file profile.h.

References PROF_TIMER::m_name.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), RES_EQUIV_CALC::Calculate(), RN_NET::compute(), SCH_EDIT_FRAME::OpenProjectFiles(), CN_CONNECTIVITY_ALGO::searchConnections(), PCB_TEST_FRAME_BASE::SetBoard(), SCH_SCREEN::TestDanglingEnds(), and CONNECTIVITY_DATA::updateRatsnest().

◆ SinceStart()

template<typename DURATION >

DURATION PROF_TIMER::SinceStart ( bool aSinceLast = false )

inlineinherited

Returns: the time since the timer was started. If the timer is stopped, the duration is from the start time to the time it was stopped, else it is to the current time.

Definition at line 135 of file profile.h.

References PROF_TIMER::m_lasttime, PROF_TIMER::m_running, PROF_TIMER::m_starttime, and PROF_TIMER::m_stoptime.

Referenced by parse(), and SCOPED_PROF_TIMER< DURATION >::~SCOPED_PROF_TIMER().