docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class AggregationEvent

    Event class which contains the aggregated data.

    Inheritance
    object
    EventBase
    AggregationEvent
    Inherited Members
    EventBase.dispatchDelegate
    EventBase.collector
    EventBase.eventName
    EventBase.allowMultipledEventsOfType
    EventBase.resetOnEachSampleCollection
    EventBase.IsMultipleEventsInstancesAllowed()
    EventBase.Update(float)
    EventBase._elapsedInterval
    EventBase._elapsedPeriod
    EventBase._interval
    EventBase._period
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.SimulationPro
    Assembly: Unity.SimulationPro.Capture.dll
    Syntax
    [Serializable]
    public class AggregationEvent : EventBase

    Constructors

    AggregationEvent(string, float, EventCollectionDelegate, bool)

    Constucts an Event that collects a metric each interval and aggregates over a period.

    Declaration
    public AggregationEvent(string eventName, float interval, ContinuousEvents.EventCollectionDelegate collector = null, bool resetOnEachSample = true)
    Parameters
    Type Name Description
    string eventName

    The name of the event.

    float interval

    The interval in which to collect the metric, in seconds.

    ContinuousEvents.EventCollectionDelegate collector

    A delegate to collect the metric.

    bool resetOnEachSample

    Whether to reset aggregated values before each sample collection.

    Fields

    max

    The max value collected over the aggregation period.

    Declaration
    public double max
    Field Value
    Type Description
    double

    mean

    The mean value collected over the aggregation period.

    Declaration
    public double mean
    Field Value
    Type Description
    double

    min

    The min value collected over the aggregation period.

    Declaration
    public double min
    Field Value
    Type Description
    double

    variance

    The variance of the values collected over the aggregation period.

    Declaration
    public double variance
    Field Value
    Type Description
    double

    Methods

    IngestValue(double)

    IngestValue method.

    Declaration
    public override void IngestValue(double value)
    Parameters
    Type Name Description
    double value

    Associated value in a key-value pair.

    Overrides
    EventBase.IngestValue(double)

    Reset()

    Reset method.

    Declaration
    public override void Reset()
    Overrides
    EventBase.Reset()
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)