This class contains profiler statistics information. More...

#include <CProfilerData2.h>

Public Types
enum	ETimeType { ENetTimes , EGrossTimes , ECallTimes , EPeriodTimes , EOutsideTimes , EInactiveTimes = EOutsideTimes , EUnknown }
	Time types. More...

Public Member Functions
areaHandle_t	getAreaId () const
	Returns ID of the profiler area (function, variable, AUX, ...), for which this statistics was measured.
std::string	getAreaName () const
	Returns name of the profiler area (function or variable), for which this statistics was measured.
int64_t	getAreaValue () const
	Returns value of the state area, for which this statistics was measured.
int64_t	getAverageTime (ETimeType timeType)
	Returns average time in nanoseconds for the given time type.
int64_t	getCallAverageTime () const
int64_t	getCallMaxTime () const
int64_t	getCallMinTime () const
int64_t	getCallTotalTime () const
int64_t	getGrossAverageTime () const
int64_t	getGrossMaxTime () const
int64_t	getGrossMinTime () const
int64_t	getGrossTotalTime () const
DWORD	getHandle () const
int64_t	getMaxEndTime (ETimeType timeType)
	Returns max end time in nanoseconds for the given time type.
int64_t	getMaxStartTime (ETimeType timeType)
	Returns max start time in nanoseconds for the given time type.
int64_t	getMaxTime (ETimeType timeType)
	Returns max time in nanoseconds for the given time type.
int64_t	getMinEndTime (ETimeType timeType)
	Returns min end time in nanoseconds for the given time type.
int64_t	getMinStartTime (ETimeType timeType)
	Returns min start time in nanoseconds for the given time type.
int64_t	getMinTime (ETimeType timeType)
	Returns min time in nanoseconds for the given time type.
int64_t	getNetAverageTime () const
int64_t	getNetMaxTime () const
int64_t	getNetMinTime () const
int64_t	getNetTotalTime () const
DWORD	getNumHits () const
	Returns the number of hits.
int64_t	getOutsideAverageTime () const
int64_t	getOutsideMaxTime () const
int64_t	getOutsideMinTime () const
int64_t	getOutsideTotalTime () const
std::string	getParentAreaName () const
	For state variables areas returns name of parent area (variable).
int64_t	getPeriodAverageTime () const
int64_t	getPeriodMaxTime () const
int64_t	getPeriodMinTime () const
int64_t	getTotalTime (ETimeType timeType)
	Returns total time in nanoseconds for the given time type.
double	getValueAverage ()
	Returns average value if area is regular variable.
double	getValueMax ()
	Returns max value if area is regular variable.
double	getValueMin ()
	Returns min value if area is regular variable.
int64_t	getValueTimeOfMax ()
	Returns time in nanoseconds when max value appeared for the first time, if area is regular variable.
int64_t	getValueTimeOfMin ()
	Returns time in nanoseconds when min value appeared for the first time, if area is regular variable.
std::string	toString () const
	Returns string representation of this object.

Detailed Description

This class contains profiler statistics information.

Python example: profiler_data.py

Member Enumeration Documentation

◆ ETimeType

enum isys::CProfilerStatistics2::ETimeType

Time types.

Enumerator
ENetTimes	Identifies net times for function execution. Net time is time spent for code inside function body, without sub-functions called from this function.
EGrossTimes	Identifies gross times for function execution. Gross time is time spent for code inside function body, AND sub-functions called from this function.
ECallTimes	Identifies call times for function execution. Call time is gross time plus time spent in other contexts (tasks, interrupts) between entry/exit of this function.
EPeriodTimes	Identifies times between function invocation. Total time is not defined for this type of time.
EOutsideTimes	Deprecated use EInactiveTimes instead
EInactiveTimes	Identifies inactive time for function execution or state variable - the time spent outside the body of the function or a state.

Member Function Documentation

◆ getAreaId()

areaHandle_t isys::CProfilerStatistics2::getAreaId ( ) const

inline

Returns ID of the profiler area (function, variable, AUX, ...), for which this statistics was measured.

Since: 9.12.288

◆ getAreaName()

std::string isys::CProfilerStatistics2::getAreaName ( ) const

inline

Returns name of the profiler area (function or variable), for which this statistics was measured.

Since: 9.12.288

◆ getAreaValue()

int64_t isys::CProfilerStatistics2::getAreaValue ( ) const

inline

Returns value of the state area, for which this statistics was measured.

If it is not state area, this method always returns 0.

Since: 9.12.288

◆ getAverageTime()

int64_t isys::CProfilerStatistics2::getAverageTime ( ETimeType timeType )

inline

Returns average time in nanoseconds for the given time type.

Since: 9.12.288

◆ getCallAverageTime()

int64_t isys::CProfilerStatistics2::getCallAverageTime ( ) const

inline

Deprecated: use getAverageTime(ETimeType) instead. Returns the average call time in nanoseconds for function execution. Call time is gross time plus time spent in other contexts (tasks, interrupts) between entry/exit of this function.

Since: 9.12.288

◆ getCallMaxTime()

int64_t isys::CProfilerStatistics2::getCallMaxTime ( ) const

inline

Deprecated: use getMaxTime(ETimeType) instead. Returns the max call time in nanoseconds for function execution. Call time is gross time plus time spent in other contexts (tasks, interrupts) between entry/exit of this function.

Since: 9.12.288

◆ getCallMinTime()

int64_t isys::CProfilerStatistics2::getCallMinTime ( ) const

inline

Deprecated: use getMinTime(ETimeType) instead. Returns the min call time in nanoseconds for function execution. Call time is gross time plus time spent in other contexts (tasks, interrupts) between entry/exit of this function.

Since: 9.12.288

◆ getCallTotalTime()

int64_t isys::CProfilerStatistics2::getCallTotalTime ( ) const

inline

Deprecated: use getTotalTime(ETimeType) instead. Returns the total call time in nanoseconds for function execution. Call time is gross time plus time spent in other contexts (tasks, interrupts) between entry/exit of this function.

Since: 9.12.288

◆ getGrossAverageTime()

int64_t isys::CProfilerStatistics2::getGrossAverageTime ( ) const

inline

Deprecated: use getAverageTime(ETimeType) instead. Returns the average gross time in nanoseconds for function execution. Gross time is time spent for code inside function body, AND sub-functions called from this function.

Since: 9.12.288

◆ getGrossMaxTime()

int64_t isys::CProfilerStatistics2::getGrossMaxTime ( ) const

inline

Deprecated: use getMaxTime(ETimeType) instead. Returns the max gross time in nanoseconds for function execution. Gross time is time spent for code inside function body, AND sub-functions called from this function.

Since: 9.12.288

◆ getGrossMinTime()

int64_t isys::CProfilerStatistics2::getGrossMinTime ( ) const

inline

Deprecated: use getMinTime(ETimeType) instead. Returns the min gross time in nanoseconds for function execution. Gross time is time spent for code inside function body, AND sub-functions called from this function.

Since: 9.12.288

◆ getGrossTotalTime()

int64_t isys::CProfilerStatistics2::getGrossTotalTime ( ) const

inline

Deprecated: use getTotalTime(ETimeType) instead. Returns the total gross time in nanoseconds for function execution. Gross time is time spent for code inside function body, AND sub-functions called from this function.

Since: 9.12.288

◆ getHandle()

DWORD isys::CProfilerStatistics2::getHandle ( ) const

inline

Deprecated: use getAreaId instead

Since: 9.12.288

Returns handle of the profiler area (function, variable, AUX, ...), for which this statistics was measured.

◆ getMaxEndTime()

int64_t isys::CProfilerStatistics2::getMaxEndTime ( ETimeType timeType )

inline

Returns max end time in nanoseconds for the given time type.

Since: 9.12.288

◆ getMaxStartTime()

int64_t isys::CProfilerStatistics2::getMaxStartTime ( ETimeType timeType )

inline

Returns max start time in nanoseconds for the given time type.

Since: 9.12.288

◆ getMaxTime()

int64_t isys::CProfilerStatistics2::getMaxTime ( ETimeType timeType )

inline

Returns max time in nanoseconds for the given time type.

Since: 9.12.288

◆ getMinEndTime()

int64_t isys::CProfilerStatistics2::getMinEndTime ( ETimeType timeType )

inline

Returns min end time in nanoseconds for the given time type.

Since: 9.12.288

◆ getMinStartTime()

int64_t isys::CProfilerStatistics2::getMinStartTime ( ETimeType timeType )

inline

Returns min start time in nanoseconds for the given time type.

Since: 9.12.288

◆ getMinTime()

int64_t isys::CProfilerStatistics2::getMinTime ( ETimeType timeType )

inline

Returns min time in nanoseconds for the given time type.

Since: 9.12.288

◆ getNetAverageTime()

int64_t isys::CProfilerStatistics2::getNetAverageTime ( ) const

inline

Deprecated: use getAverageTime(ETimeType) instead. Returns the average net time in nanoseconds for function execution. Net time is time spent for code inside function body, without sub-functions called from this function.

Since: 9.12.288

◆ getNetMaxTime()

int64_t isys::CProfilerStatistics2::getNetMaxTime ( ) const

inline

Deprecated: use getMaxTime(ETimeType) instead. Returns the max net time in nanoseconds for function execution. Net time is time spent for code inside function body, without sub-functions called from this function.

Since: 9.12.288

◆ getNetMinTime()

int64_t isys::CProfilerStatistics2::getNetMinTime ( ) const

inline

Deprecated: use getMinTime(ETimeType) instead. Returns the min net time in nanoseconds for function execution. Net time is time spent for code inside function body, without sub-functions called from this function.

Since: 9.12.288

◆ getNetTotalTime()

int64_t isys::CProfilerStatistics2::getNetTotalTime ( ) const

inline

Deprecated: use getTotalTime(ETimeType) instead.

Since: 9.12.288

Returns the total net time in nanoseconds for function execution. Net time is time spent for code inside function body, without sub-functions called from this function.

◆ getNumHits()

DWORD isys::CProfilerStatistics2::getNumHits ( ) const

inline

Returns the number of hits.

Since: 9.12.288

◆ getOutsideAverageTime()

int64_t isys::CProfilerStatistics2::getOutsideAverageTime ( ) const

inline

Deprecated: use getAverageTime(ETimeType) instead. Returns the average outside time in nanoseconds for function execution. Outside Time indicates the time spent outside the body of the function or a state - where the function state is Inactive.

Since: 9.12.288

◆ getOutsideMaxTime()

int64_t isys::CProfilerStatistics2::getOutsideMaxTime ( ) const

inline

Deprecated: use getMaxTime(ETimeType) instead. Returns the max outside time in nanoseconds for function execution. Outside Time indicates the time spent outside the body of the function or a state - where the function state is Inactive.

Since: 9.12.288

◆ getOutsideMinTime()

int64_t isys::CProfilerStatistics2::getOutsideMinTime ( ) const

inline

Deprecated: use getMinTime(ETimeType) instead. Returns the min outside time in nanoseconds for function execution. Outside Time indicates the time spent outside the body of the function or a state - where the function state is Inactive.

Since: 9.12.288

◆ getOutsideTotalTime()

int64_t isys::CProfilerStatistics2::getOutsideTotalTime ( ) const

inline

Deprecated: use getTotalTime(ETimeType) instead. Returns the total outside time in nanoseconds for function execution. Outside Time indicates the time spent outside the body of the function or a state - where the function state is Inactive.

Since: 9.12.288

◆ getParentAreaName()

std::string isys::CProfilerStatistics2::getParentAreaName ( ) const

inline

For state variables areas returns name of parent area (variable).

Empty for other areas.

Since: 9.12.288

◆ getPeriodAverageTime()

int64_t isys::CProfilerStatistics2::getPeriodAverageTime ( ) const

inline

Deprecated: use getAverageTime(ETimeType) instead. Returns the average time in nanoseconds between function invocation.

Since: 9.12.288

◆ getPeriodMaxTime()

int64_t isys::CProfilerStatistics2::getPeriodMaxTime ( ) const

inline

Deprecated: use getMaxTime(ETimeType) instead. Returns the maximum time in nanoseconds between function invocation.

Since: 9.12.288

◆ getPeriodMinTime()

int64_t isys::CProfilerStatistics2::getPeriodMinTime ( ) const

inline

Deprecated: use getMinTime(ETimeType) instead. Returns the minimum time in nanoseconds between function invocation.

Since: 9.12.288

◆ getTotalTime()

int64_t isys::CProfilerStatistics2::getTotalTime ( ETimeType timeType )

inline

Returns total time in nanoseconds for the given time type.

Since: 9.12.288

◆ getValueAverage()

double isys::CProfilerStatistics2::getValueAverage ( )

inline

Returns average value if area is regular variable.

Since: 9.12.288

◆ getValueMax()

double isys::CProfilerStatistics2::getValueMax ( )

inline

Returns max value if area is regular variable.

Since: 9.12.288

◆ getValueMin()

double isys::CProfilerStatistics2::getValueMin ( )

inline

Returns min value if area is regular variable.

Since: 9.12.288

◆ getValueTimeOfMax()

int64_t isys::CProfilerStatistics2::getValueTimeOfMax ( )

inline

Returns time in nanoseconds when max value appeared for the first time, if area is regular variable.

Since: 9.12.288

◆ getValueTimeOfMin()

int64_t isys::CProfilerStatistics2::getValueTimeOfMin ( )

inline

Returns time in nanoseconds when min value appeared for the first time, if area is regular variable.

Since: 9.12.288

◆ toString()

std::string isys::CProfilerStatistics2::toString ( ) const

inline

Returns string representation of this object.

Since: 9.12.288

winIDEA SDK

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ETimeType

Member Function Documentation

◆ getAreaId()

◆ getAreaName()

◆ getAreaValue()

◆ getAverageTime()

◆ getCallAverageTime()

◆ getCallMaxTime()

◆ getCallMinTime()

◆ getCallTotalTime()

◆ getGrossAverageTime()

◆ getGrossMaxTime()

◆ getGrossMinTime()

◆ getGrossTotalTime()

◆ getHandle()

◆ getMaxEndTime()

◆ getMaxStartTime()

◆ getMaxTime()

◆ getMinEndTime()

◆ getMinStartTime()

◆ getMinTime()

◆ getNetAverageTime()

◆ getNetMaxTime()

◆ getNetMinTime()

◆ getNetTotalTime()

◆ getNumHits()

◆ getOutsideAverageTime()

◆ getOutsideMaxTime()

◆ getOutsideMinTime()

◆ getOutsideTotalTime()

◆ getParentAreaName()

◆ getPeriodAverageTime()

◆ getPeriodMaxTime()

◆ getPeriodMinTime()

◆ getTotalTime()

◆ getValueAverage()

◆ getValueMax()

◆ getValueMin()

◆ getValueTimeOfMax()

◆ getValueTimeOfMin()

◆ toString()