EventGroup class

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

The EventGroup class template is the base class for all group capture classes.

Syntax

template <typename TActivity>
class EventGroup;
{
public:
    size_t Size() const;

    const TActivity& operator[](size_t index) const;
    const TActivity& Front() const;
    const TActivity& Back() const;

    std::deque<TActivity>::const_iterator begin() const;
    std::deque<TActivity>::const_iterator end() const;
};

Parameters

TActivity The activity type contained in the group.

Members

Functions

Back begin end Front operator[] Size

Back

const TActivity& Back() const;

Return Value

A reference to the last activity event in the group.

begin

std::deque<TActivity>::const_iterator begin() const;

Return Value

An iterator pointing at the beginning of the activity event group.

end

std::deque<TActivity>::const_iterator end() const;

Return Value

An iterator pointing one position past the end of the activity event group.

Front

const TActivity& Front() const;

Return Value

A reference to the first activity event in the group.

operator[]

const TActivity& operator[](size_t index) const;

Parameters

index
The index of the element to access in the activity event group.

Return Value

The event from the event stack stored at the position indicated by index.

Size

size_t Size() const;

Return Value

The size of the event group.