Kanzi  3.9.4
Kanzi Engine API
kanzi::IntervalProfilingSampler Class Reference

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

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

Inheritance diagram for kanzi::IntervalProfilingSampler:
[legend]

Public Member Functions

IntervalProfilerSampleData getSampleData ()
 Returns IntervalProfilerSampleData sample including interval measurement data. More...
 
void start ()
 Starts measuring time interval duration. More...
 
void stop ()
 Finishes measuring time interval duration. More...
 

Protected Attributes

TimePoint m_endTimePoint
 The point in time when interval measurement finished. More...
 
TimePoint m_startTimePoint
 The point in time when interval measurement started. More...
 

Detailed Description

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

The ProfilingScopeHelper uses sampler class to measure time spent executing scope which is profiled.

For information on how the sampler is used in scope profiling, See ProfilingScopeHelper.

Member Function Documentation

◆ start()

void kanzi::IntervalProfilingSampler::start ( )
inline

Starts measuring time interval duration.

◆ stop()

void kanzi::IntervalProfilingSampler::stop ( )
inline

Finishes measuring time interval duration.

◆ getSampleData()

IntervalProfilerSampleData kanzi::IntervalProfilingSampler::getSampleData ( )
inline

Returns IntervalProfilerSampleData sample including interval measurement data.

Returns
The interval measurement sample.

Member Data Documentation

◆ m_startTimePoint

TimePoint kanzi::IntervalProfilingSampler::m_startTimePoint
protected

The point in time when interval measurement started.

◆ m_endTimePoint

TimePoint kanzi::IntervalProfilingSampler::m_endTimePoint
protected

The point in time when interval measurement finished.


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