Activity class

The Activity class is used with the MatchEvent, MatchEventInMemberFunction, MatchEventStack, and MatchEventStackInMemberFunction functions. Use it to match any activity event. Refer to event table to see all events that can be matched by the Activity class.

Syntax

class Activity : public Event
{
public:
    Activity(const RawEvent& event);

    const long long& StartTimestamp() const;
    const long long& StopTimestamp() const;
    const long long& ExclusiveDurationTicks() const;
    const long long& CPUTicks() const;
    const long long& ExclusiveCPUTicks() const;
    const long long& WallClockTimeResponsibilityTicks() const;
    const long long& ExclusiveWallClockTimeResponsibilityTicks() const;

    std::chrono::nanoseconds Duration() const;
    std::chrono::nanoseconds ExclusiveDuration() const;
    std::chrono::nanoseconds CPUTime() const ;
    std::chrono::nanoseconds ExclusiveCPUTime() const;
    std::chrono::nanoseconds WallClockTimeResponsibility() const;
    std::chrono::nanoseconds ExclusiveWallClockTimeResponsibility() const;
};

Remarks

Several member functions in the Activity class return a tick count. C++ Build Insights uses Windows' performance counter as a source of ticks. A tick count must be used with a tick frequency to convert it into a time unit such as seconds. The TickFrequency member function, available in the Event base class, may be called to obtain the tick frequency. The EVENT_DATA page shows an example of converting ticks into a time unit.

If you don't want to convert ticks to time units yourself, the Activity class provides member functions that return time values in nanoseconds. Use the standard C++ chrono library to convert them into other time units.

Members

Along with its members inherited from the Event base class, the Activity class contains the following members:

Constructor

Activity

Functions

CPUTicks
CPUTime
Duration
ExclusiveCPUTicks
ExclusiveCPUTime
ExclusiveDuration
ExclusiveDurationTicks
ExclusiveWallClockTimeResponsibility
ExclusiveWallClockTimeResponsibilityTicks
StartTimestamp
StopTimestamp
WallClockTimeResponsibility
WallClockTimeResponsibilityTicks

Activity

Activity(const RawEvent& event);

Parameters

event
Any activity event.

CPUTicks

const long long& CPUTicks() const;

Return Value

The number of CPU ticks that occurred during this activity. A CPU tick is different from a regular tick. CPU ticks are only counted when the CPU is executing code in an activity. CPU ticks aren't counted when the thread associated with the activity is sleeping.

CPUTime

std::chrono::nanoseconds CPUTime()() const;

Return Value

The amount of time the CPU was executing code inside this activity. This value may be higher than the duration of the activity if child activities are executed on separate threads. The value is returned in nanoseconds.

Duration

std::chrono::nanoseconds Duration() const;

Return Value

The duration of the activity in nanoseconds.

ExclusiveCPUTicks

const long long& ExclusiveCPUTicks() const;

Return Value

Same as CPUTicks, but not including the CPU ticks that occurred in child activities.

ExclusiveCPUTime

std::chrono::nanoseconds ExclusiveCPUTime() const;

Return Value

Same as CPUTime, except that the CPU time of child activities isn't included.

ExclusiveDuration

std::chrono::nanoseconds ExclusiveDuration() const;

Return Value

The duration of the activity in nanoseconds, not including the amount of time that was spent in child activities.

ExclusiveDurationTicks

const long long& ExclusiveDurationTicks() const;

Return Value

The number of ticks that occurred in this activity, excluding the number of ticks that occurred in child activities.

ExclusiveWallClockTimeResponsibility

std::chrono::nanoseconds ExclusiveWallClockTimeResponsibility() const;

Return Value

Same as WallClockTimeResponsibility, but not including the wall-clock time responsibility of child activities.

ExclusiveWallClockTimeResponsibilityTicks

const long long& ExclusiveWallClockTimeResponsibilityTicks() const;

Return Value

Same as WallClockTimeResponsibilityTicks, but not including the wall-clock time responsibility ticks of child activities.

StartTimestamp

const long long& StartTimestamp() const;

Return Value

A tick value captured at the time the activity started.

StopTimestamp

const long long& StopTimestamp() const;

Return Value

A tick value captured at the time the activity stopped.

WallClockTimeResponsibility

std::chrono::nanoseconds WallClockTimeResponsibility() const;

Return Value

The wall-clock time responsibility of this activity, in nanoseconds. For more information on what wall-clock time responsibility means, see WallClockTimeResponsibilityTicks.

WallClockTimeResponsibilityTicks

const long long& WallClockTimeResponsibilityTicks() const;

Return Value

A tick count that represents this activity's contribution to overall wall-clock time. A wall-clock time responsibility tick is different from a regular tick. Wall-clock time responsibility ticks take into account parallelism between activities. Two parallel activities may have a duration of 50 ticks, and the same start and stop time. In this case, both get assigned a wall-clock time responsibility of 25 ticks.