aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Integration/Operation/IMachineEventsStateProvider.cs
blob: e6084c12afdae209306e640f0a2f1aa5f2a79998 (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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.PMR.Diagnostics;

namespace Tango.Integration.Operation
{
    /// <summary>
    /// Represents a machine event states provider used by the machine provider to notify about current machine events and errors.
    /// </summary>
    public interface IMachineEventsStateProvider
    {
        /// <summary>
        /// Gets the current machine events.
        /// </summary>
        ReadOnlyObservableCollection<MachinesEvent> Events { get; }

        /// <summary>
        /// Gets or sets a value indicating whether this instance has events.
        /// </summary>
        bool HasEvents { get; }

        /// <summary>
        /// Occurs when new events are available.
        /// </summary>
        event EventHandler<IEnumerable<MachinesEvent>> NewEvents;

        /// <summary>
        /// Occurs when old events has been resolved.
        /// </summary>
        event EventHandler<IEnumerable<MachinesEvent>> EventsResolved;

        /// <summary>
        /// Occurs when a new events states has been received.
        /// </summary>
        event EventHandler<IEnumerable<MachinesEvent>> EventsReceived;

        /// <summary>
        /// Occurs when the collection of current events has changed.
        /// </summary>
        event EventHandler<IEnumerable<MachinesEvent>> EventsChanged;

        /// <summary>
        /// Applies the collection of events received from the machine operator.
        /// </summary>
        /// <param name="events">The events.</param>
        void ApplyEvents(IEnumerable<Event> events);

        /// <summary>
        /// Resets the current events tracking.
        /// </summary>
        void Reset();
    }
}