kanzi::MainLoopTaskProfilingSampler Class Reference

The main loop task profiling sampler collects interval measurement to produce #MainLoopTaskProfilerSampleData sample. More...

#include <kanzi/core/profiling/main_loop_profiler_sample.hpp>

Inheritance diagram for kanzi::MainLoopTaskProfilingSampler:

Public Member Functions
	MainLoopTaskProfilingSampler (size_t counter)
	Constructor. More...
MainLoopTaskProfilerSampleData	getSampleData ()
	Returns #MainLoopTaskProfilerSampleData sample including interval measurement data and main loop counter. More...
Public Member Functions inherited from kanzi::IntervalProfilingSampler
void	start ()
	Starts measuring time interval duration. More...
void	stop ()
	Finishes measuring time interval duration. More...
IntervalProfilerSampleData	getSampleData ()
	Returns IntervalProfilerSampleData sample including interval measurement data. More...

Additional Inherited Members
Protected Attributes inherited from kanzi::IntervalProfilingSampler
chrono::steady_clock::time_point	m_startTimePoint
	The point in time when interval measurement started. More...
chrono::steady_clock::time_point	m_endTimePoint
	The point in time when interval measurement finished. More...

Detailed Description

The main loop task profiling sampler collects interval measurement to produce #MainLoopTaskProfilerSampleData sample.

The #ProfilingScopeHelper uses sampler class to measure time spent executing scope which is profiled. For detailed information on how the sampler is used in scope profiling, refer to #ProfilingScopeHelper.

Constructor & Destructor Documentation

kanzi::MainLoopTaskProfilingSampler::MainLoopTaskProfilingSampler ( size_t  counter )

inlineexplicit

Constructor.

Initializes main loop counter to include it into #MainLoopTaskProfilerSampleData sample.

Parameters

counter

The main loop counter.

Member Function Documentation

MainLoopTaskProfilerSampleData kanzi::MainLoopTaskProfilingSampler::getSampleData ( )

inline

Returns #MainLoopTaskProfilerSampleData sample including interval measurement data and main loop counter.

Returns

The main loop task profiling sample.

---

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

• kanzi/core/profiling/main_loop_profiler_sample.hpp