winIDEA SDK
Loading...
Searching...
No Matches
isys::CProfilerTimeEvent Class Reference

This class contains information of one profiler time-line event. More...

#include <CProfilerData2.h>

Public Types

enum  EEventType {
  EEvAny , EEvWrite ,
  EEvSuspend , EEvResume ,
  EEvEnter , EEvExit
}
 This enum defines profiler time-line events. More...

Public Member Functions

areaHandle_t getAreaId ()
 Returns ID of the area, for which event was recorded.
int getEventSource ()
 Returns source of event or -1 if it does not exist for an event.
EEventType getEventType ()
 Returns event type.
double getFloatValue ()
 Returns float value of float variables and analog AUX ports, 0 for functions.
DWORD getHandle ()
int64_t getSignedValue ()
int64_t getTime ()
 Returns time of event in nanoseconds.
std::string getUnit ()
 Returns unit of analog AUX port, empty string for all other areas.
int64_t getValue ()
 Returns value of integer variable or digital AUX port.
std::string toString ()
 Returns string representation of this object.

Detailed Description

This class contains information of one profiler time-line event.

Python example: profiler_data.py

Member Enumeration Documentation

◆ EEventType

enum isys::CProfilerTimeEvent::EEventType

This enum defines profiler time-line events.

Enumerator
EEvAny 

any event, this value can be used by iterator to return all events

EEvWrite 

variable write events

EEvSuspend 

function/task/interrupt/... execution was suspended, for example function called another function

EEvResume 

function/task/interrupt/... execution was resumed, for example function call returned to the function which called it

EEvEnter 

function/task/interrupt/... execution started

EEvExit 

function/task/interrupt/... execution ended

Member Function Documentation

◆ getAreaId()

areaHandle_t isys::CProfilerTimeEvent::getAreaId ( )
inline

Returns ID of the area, for which event was recorded.

Since
9.12.288

◆ getEventSource()

int isys::CProfilerTimeEvent::getEventSource ( )
inline

Returns source of event or -1 if it does not exist for an event.

Since
9.12.288

◆ getEventType()

EEventType isys::CProfilerTimeEvent::getEventType ( )
inline

Returns event type.

Since
9.12.288

◆ getFloatValue()

double isys::CProfilerTimeEvent::getFloatValue ( )
inline

Returns float value of float variables and analog AUX ports, 0 for functions.

Since
9.12.288

◆ getHandle()

DWORD isys::CProfilerTimeEvent::getHandle ( )
inline
Deprecated
since 9.12.295 (dec 2016). Use getAreaId() Returns ID of the area, for which event was recorded.
Since
9.12.288

◆ getSignedValue()

int64_t isys::CProfilerTimeEvent::getSignedValue ( )
inline
Deprecated
use getValue().
Since
9.12.288

Returns value of integer variable or digital AUX port, 0 for functions.

◆ getTime()

int64_t isys::CProfilerTimeEvent::getTime ( )
inline

Returns time of event in nanoseconds.

Since
9.12.288

◆ getUnit()

std::string isys::CProfilerTimeEvent::getUnit ( )
inline

Returns unit of analog AUX port, empty string for all other areas.

Since
9.12.288

◆ getValue()

int64_t isys::CProfilerTimeEvent::getValue ( )
inline

Returns value of integer variable or digital AUX port.

Always check value type of area, to interpret the number correctly, for example:

  area = profiler_data.getArea(event.getHandle())
  valueType = area.getValueType()[0]
  if valueType == 'I':    # unsigned integer type
      print(timelineEvents[2].getValue() & 0xffffFFFFffffFFFF)
  elif valueType == 'S':  # signed integer type
      print(timelineEvents[2].getValue())
  elif valueType == 'F':  # floating point (double) type
      print(timelineEvents[2].getFloatValue())
Since
9.12.288

◆ toString()

std::string isys::CProfilerTimeEvent::toString ( )
inline

Returns string representation of this object.

Since
9.12.288