ProfilingEvent.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using System.Collections.Generic;

namespace SiliconStudio.Core.Diagnostics
{
    /// <summary>
    /// A profiling event generated by <see cref="Profiler"/>.
    /// </summary>
    public struct ProfilingEvent
    {
        /// <summary>
        /// The unique identifier.
        /// </summary>
        public readonly int Id;

        /// <summary>
        /// The profile key.
        /// </summary>
        public readonly ProfilingKey Key;

        /// <summary>
        /// The type of the profile.
        /// </summary>
        public readonly ProfilingMessageType Type;

        /// <summary>
        /// The timestamp.
        /// </summary>
        public readonly long TimeStamp;

        /// <summary>
        /// The elapsed time since Begin event.
        /// </summary>
        public readonly long ElapsedTime;

        /// <summary>
        /// The text.
        /// </summary>
        public readonly string Text;

        /// <summary>
        /// The attributes
        /// </summary>
        public readonly Dictionary<object, object> Attributes;

        /// <summary>
        /// Initializes a new instance of the <see cref="ProfilingEvent" /> struct.
        /// </summary>
        /// <param name="profileId">The profile identifier.</param>
        /// <param name="profilingKey">The profiling key.</param>
        /// <param name="profilingType">Type of the profiling.</param>
        /// <param name="elapsedTime">The elapsed time.</param>
        /// <param name="text">The text.</param>
        /// <param name="attributes">The attributes.</param>
        public ProfilingEvent(int profileId, ProfilingKey profilingKey, ProfilingMessageType profilingType, long timeStamp, long elapsedTime, string text, Dictionary<object, object> attributes)
        {
            Id = profileId;
            Key = profilingKey;
            Type = profilingType;
            TimeStamp = timeStamp;
            ElapsedTime = elapsedTime;
            Text = text;
            Attributes = attributes;
        }
    }
}