Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::NamedIntervalProfilerSampleData Struct Reference

The named interval profiler data sample. More...

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

Public Member Functions

 NamedIntervalProfilerSampleData (TimePoint startTimePoint, chrono::nanoseconds duration, string scopeName, string objectName)
 Constructor. More...
 

Public Attributes

chrono::nanoseconds m_duration
 The duration of the interval. More...
 
string m_objectName
 The name of the object that the code block was operating on. More...
 
string m_scopeName
 The name of the measured code block. More...
 
TimePoint m_startTimePoint
 The point in time when interval measurement started. More...
 

Detailed Description

The named interval profiler data sample.

Use Profiling macros to profile codepath execution time.

This structure keeps interval measurement data that is produced by NamedIntervalProfiler and NamedIntervalProfilerSampler. The measurement data contains the time and duration of an execution of a code block, an string identifier to name the code block, and a string identifier to name the object that the code block was operating on. For example when the block name is "NodeAttach" and the object is "Screen", the duration tells how long it took to attach the Screen node.

Constructor & Destructor Documentation

◆ NamedIntervalProfilerSampleData()

kanzi::NamedIntervalProfilerSampleData::NamedIntervalProfilerSampleData ( TimePoint  startTimePoint,
chrono::nanoseconds  duration,
string  scopeName,
string  objectName 
)
inlineexplicit

Constructor.

Parameters
startTimePointThe point in time when measurement started.
durationThe interval duration.
scopeNameThe name of the measure scope.
objectNameThe name of the object that the scope is operating on.

Member Data Documentation

◆ m_startTimePoint

TimePoint kanzi::NamedIntervalProfilerSampleData::m_startTimePoint

The point in time when interval measurement started.

◆ m_duration

chrono::nanoseconds kanzi::NamedIntervalProfilerSampleData::m_duration

The duration of the interval.

◆ m_scopeName

string kanzi::NamedIntervalProfilerSampleData::m_scopeName

The name of the measured code block.

◆ m_objectName

string kanzi::NamedIntervalProfilerSampleData::m_objectName

The name of the object that the code block was operating on.


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