A small class to help profiling. More...

#include <profile.h>

Inheritance diagram for PROF_TIMER:

Public Member Functions
	PROF_TIMER (const std::string &aName, bool aAutostart=true)
	Create a PROF_COUNTER for measuring an elapsed time in milliseconds.

	PROF_TIMER ()
	Create a PROF_COUNTER for measuring an elapsed time in milliseconds.

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 ()

const std::string &	GetName () const

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

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

Private Attributes
std::string	m_name

bool	m_running

bool	m_started

TIME_POINT	m_starttime

TIME_POINT	m_lasttime

TIME_POINT	m_stoptime

Detailed Description

A small class to help profiling.

It allows the calculation of the elapsed time (in milliseconds) between its creation (or the last call to Start() ) and the last call to Stop()

Definition at line 49 of file profile.h.

Member Typedef Documentation

◆ CLOCK

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

private

Definition at line 197 of file profile.h.

◆ TIME_POINT

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

private

Definition at line 198 of file profile.h.

Constructor & Destructor Documentation

◆ PROF_TIMER() [1/2]

PROF_TIMER::PROF_TIMER	(	const std::string &	aName,
		bool	aAutostart = true )

inline

Create a PROF_COUNTER for measuring an elapsed time in milliseconds.

Parameters

aName	a string that will be printed in message.
aAutostart	true (default) to immediately start the timer

Definition at line 58 of file profile.h.

References m_name, m_running, and Start().

Referenced by SCOPED_PROF_TIMER< DURATION >::SCOPED_PROF_TIMER().

◆ PROF_TIMER() [2/2]

PROF_TIMER::PROF_TIMER ( )

inline

Create a PROF_COUNTER for measuring an elapsed time in milliseconds.

The counter is started and the string to print in message is left empty.

Definition at line 70 of file profile.h.

References Start().

Member Function Documentation

◆ GetName()

const std::string & PROF_TIMER::GetName ( ) const

inline

Definition at line 190 of file profile.h.

References m_name.

Referenced by LATENCY_PROBE::AddTimer().

◆ msecs()

double PROF_TIMER::msecs ( bool aSinceLast = false )

inline

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 151 of file profile.h.

References SinceStart().

Referenced by LATENCY_PROBE::AddTimer(), ALLEGRO::BOARD_BUILDER::applyZoneFills(), KIGFX::OPENGL_GAL::BeginDrawing(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ALLEGRO::BOARD_BUILDER::BuildBoard(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), KIGFX::GPU_NONCACHED_MANAGER::EndDrawing(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), GetNodeCount(), PCB_IO_ALLEGRO::LoadBoardFromData(), PCB_EDIT_FRAME::OpenProjectFiles(), ALLEGRO::PARSER::Parse(), ALLEGRO::BOARD_BUILDER::ZONE_FILL_HANDLER::ProcessPolygons(), SCHEMATIC::RecalculateConnections(), KIGFX::VIEW::Redraw(), PNS_LOG_PLAYER::ReplayLog(), ITEM_EVAL_EXPECTATION::RunTest(), DRC_ENGINE::RunTests(), DATABASE_CONNECTION::selectAllAndCache(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), and DATABASE_CONNECTION::SelectOne().

◆ Show()

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

inline

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 107 of file profile.h.

References m_name, and SinceStart().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), RES_EQUIV_CALC::Calculate(), RN_NET::compute(), SCH_EDIT_FRAME::OpenProjectFiles(), polygon_triangulation_main(), CONNECTION_GRAPH::Recalculate(), 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 )

inline

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 137 of file profile.h.

References m_lasttime, m_running, m_starttime, and m_stoptime.

Referenced by PCB_PARSE_RUNNER::doParse(), msecs(), Show(), and to_string().

◆ Start()

void PROF_TIMER::Start ( )

inline

Start or restart the counter.

Definition at line 78 of file profile.h.

References m_lasttime, m_running, m_started, and m_starttime.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::OPENGL_GAL::EndDrawing(), PCB_IO_ALLEGRO::LoadBoardFromData(), PROF_TIMER(), PROF_TIMER(), and PCB_SELECTION_TOOL::selectAllConnectedTracks().

◆ Stop()

void PROF_TIMER::Stop ( )

inline

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

Definition at line 90 of file profile.h.

References m_running, and m_stoptime.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), BOOST_FIXTURE_TEST_CASE(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::GPU_CACHED_MANAGER::EndDrawing(), KIGFX::GPU_NONCACHED_MANAGER::EndDrawing(), KIGFX::OPENGL_GAL::EndDrawing(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), GetNodeCount(), PCB_IO_ALLEGRO::LoadBoardFromData(), CONNECTION_GRAPH::Recalculate(), SCHEMATIC::RecalculateConnections(), KIGFX::VIEW::Redraw(), SCH_EDIT_FRAME::RefreshNetNavigator(), PNS_LOG_PLAYER::ReplayLog(), MULTICHANNEL_TOOL::resolveConnectionTopology(), DRC_ENGINE::RunTests(), DATABASE_CONNECTION::selectAllAndCache(), DATABASE_CONNECTION::SelectOne(), and SCH_SCREEN::TestDanglingEnds().

◆ to_string()

std::string PROF_TIMER::to_string ( )

inline

Definition at line 157 of file profile.h.

References m_name, m_started, and SinceStart().

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::GPU_CACHED_MANAGER::EndDrawing(), KIGFX::OPENGL_GAL::EndDrawing(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), SCH_EDIT_FRAME::RefreshNetNavigator(), MULTICHANNEL_TOOL::resolveConnectionTopology(), and PCB_TEST_FRAME_BASE::SetBoard().

Member Data Documentation

◆ m_lasttime

TIME_POINT PROF_TIMER::m_lasttime

private

Definition at line 200 of file profile.h.

Referenced by SinceStart(), and Start().

◆ m_name

std::string PROF_TIMER::m_name

private

Definition at line 193 of file profile.h.

Referenced by GetName(), PROF_TIMER(), Show(), and to_string().

◆ m_running

bool PROF_TIMER::m_running

private

Definition at line 194 of file profile.h.

Referenced by PROF_TIMER(), SinceStart(), Start(), and Stop().

◆ m_started

bool PROF_TIMER::m_started

private

Definition at line 195 of file profile.h.

Referenced by Start(), and to_string().

◆ m_starttime

TIME_POINT PROF_TIMER::m_starttime

private

Definition at line 200 of file profile.h.

Referenced by SinceStart(), and Start().

◆ m_stoptime

TIME_POINT PROF_TIMER::m_stoptime

private

Definition at line 200 of file profile.h.

Referenced by SinceStart(), and Stop().

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

profile.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CLOCK

◆ TIME_POINT

Constructor & Destructor Documentation

◆ PROF_TIMER() [1/2]

◆ PROF_TIMER() [2/2]

Member Function Documentation

◆ GetName()

◆ msecs()

◆ Show()

◆ SinceStart()

◆ Start()

◆ Stop()

◆ to_string()

Member Data Documentation

◆ m_lasttime

◆ m_name

◆ m_running

◆ m_started

◆ m_starttime

◆ m_stoptime