class MAGES::Recorder::AnalyticsEvent

Overview

Represents an event captured by the analytics module. More…

class AnalyticsEvent: public MAGES::Recorder::ICapturedEvent
{
public:
    // enums

    enum AnalyticsEventType;

    // properties

    double CreateTime;
    double CaptureTime;
    long CreateFrame;
    string JsonString;
    string Name;
    AnalyticsEventType Type;

    // methods

    AnalyticsEvent(
        AnalyticsEventType type,
        string name,
        string jsonString,
        long frameCount,
        double captureTime
    );
};

Inherited Members

public:
    // properties

    long CreateFrame;
    double CreateTime;
    double CaptureTime;

Detailed Documentation

Represents an event captured by the analytics module.

Properties

double CreateTime

Gets the estimated time (wall-clock time) when the event was created (NOT captured).

double CaptureTime

Gets the estimated time (wall-clock time) when the event was captured.

long CreateFrame

Gets the frame the event was captured on.

string JsonString

Gets the JSON string representation of the event.

string Name

Gets the name of the event.

AnalyticsEventType Type

Gets the type of event.

Methods

AnalyticsEvent(
    AnalyticsEventType type,
    string name,
    string jsonString,
    long frameCount,
    double captureTime
)

Initializes a new instance of the AnalyticsEvent class.

Parameters:

type

The type of the analytics event.

name

The name of the event.

jsonString

The serialized json string of the analytic.

frameCount

The frame count.

captureTime

The timestamp.