aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/FSE/Tango.FSE.Common/Diagnostics/IDiagnosticsProvider.cs
blob: b79c766ea8a4e83642b118aa243520adea6b241c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.FSE.Common.Diagnostics
{
    /// <summary>
    /// Represents a machine diagnostics frame provider.
    /// </summary>
    public interface IDiagnosticsProvider
    {
        /// <summary>
        /// Gets the current diagnostics frame.
        /// </summary>
        DiagnosticsFrame CurrentFrame { get; }

        /// <summary>
        /// Occurs when a diagnostics frame is available.
        /// </summary>
        event EventHandler<DiagnosticsFrameReceivedEventArgs> FrameReceived;

        /// <summary>
        /// Gets or sets the diagnostics frames throttling mode.
        /// </summary>
        DiagnosticsThrottlingMode ThrottlingMode { get; set; }

        /// <summary>
        /// Gets the current frame rate.
        /// </summary>
        int FrameRate { get; }
    }
}