Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Diagnostics/IDiagnosticsFrameProvider.cs


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
35
36
37

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.Integration.Operation;
using Tango.PMR.Diagnostics;

namespace Tango.MachineStudio.Common.Diagnostics
{
    /// <summary>
    /// Represents a tango machine diagnostics frame provider.
    /// </summary>
    public interface IDiagnosticsFrameProvider
    {
        /// <summary>
        /// Occurs when a new data frame is available.
        /// </summary>
        event EventHandler<StartDiagnosticsResponse> FrameReceived;

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

        /// <summary>
        /// Disables the frame delivery from the current connected machine and enables the manual push frame method.
        /// </summary>
        bool Disable { get; set; }

        /// <summary>
        /// Push frames manual. (Only when Disable = true)
        /// </summary>
        /// <param name="frame">The frame.</param>
        void PushFrame(StartDiagnosticsResponse frame);
    }
}