kanzi::IntervalProfilerSampleData Struct Reference

The interval profiler data sample. More...

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

Inheritance diagram for kanzi::IntervalProfilerSampleData:
kanzi::MainLoopTaskProfilerSampleData

Public Member Functions

 IntervalProfilerSampleData (chrono::high_resolution_clock::time_point startTimePoint, chrono::nanoseconds duration)
 Constructor. More...
 

Public Attributes

chrono::high_resolution_clock::time_point m_startTimePoint
 The point in time when interval measurement started. More...
 
chrono::nanoseconds m_duration
 The duration of the interval. More...
 

Detailed Description

The interval profiler data sample.

Use Profiling macros to profile codepath execution time.

This structure keeps interval measurement data. Use this structure together with IntervalProfiler to profile the execution time of arbitrary codepaths. To profile the execution time of a codepath create a sample object of type IntervalProfilerSampleData and call the #start() method in the beginning of the codepath. At the end of the codepath call #stop() and pass the sample to the IntervalProfiler object.

Constructor & Destructor Documentation

kanzi::IntervalProfilerSampleData::IntervalProfilerSampleData ( chrono::high_resolution_clock::time_point  startTimePoint,
chrono::nanoseconds  duration 
)
inlineexplicit

Constructor.

Parameters
startTimePointThe point in time when measurement started.
durationThe interval duration.

Member Data Documentation

chrono::high_resolution_clock::time_point kanzi::IntervalProfilerSampleData::m_startTimePoint

The point in time when interval measurement started.

chrono::nanoseconds kanzi::IntervalProfilerSampleData::m_duration

The duration of the interval.


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