Edit

EventStack class

  • Article

The C++ Build Insights SDK is compatible with Visual Studio 2017 and later. To see the documentation for these versions, set the Visual Studio Version selector control for this article to Visual Studio 2017 or later. It's found at the top of the table of contents on this page.

The EventStack class is a collection of Event objects. All events received from the C++ Build Insights SDK come in the form of an EventStack object. The last entry in this stack is the event currently being processed. The entries that precede the last entry are the parent hierarchy of the current event. For more information on the event model used in C++ Build Insights, see event table.

Syntax

class EventStack
{
public:
    EventStack(const EVENT_COLLECTION_DATA& data);

    size_t      Size() const;
    RawEvent    Back() const;
    RawEvent    operator[] (size_t index) const;
};

Members

Constructors

EventStack

Functions

Back operator[] Size

Back

RawEvent Back() const;

Return Value

A RawEvent object that represents the last entry in the stack. The last entry in an event stack is the event that was triggered.

EventStack

EventStack(const EVENT_COLLECTION_DATA& data);

Parameters

data
The raw data from which the EventStack is built.

Remarks

You don't typically need to construct EventStack objects yourself. They're provided to you by the C++ Build Insights SDK when events are being processed during an analysis or relogging session.

operator[]

RawEvent operator[] (size_t index) const;

Parameters

index
The index of the element to access in the event stack.

Return Value

A RawEvent object that represents the event stored at the position indicated by index in the event stack.

Size

size_t Size() const;

Return Value

The size of the event stack.