aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Integration/JobRuns/IJobRunsLogger.cs
blob: 46a840a2e9df93183dc162c82a43f8b733762eca (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.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.BL.Enumerations;
using Tango.Integration.Operation;

namespace Tango.Integration.JobRuns
{
    /// <summary>
    /// Represents a machine operator job runs logger
    /// </summary>
    public interface IJobRunsLogger
    {
        /// <summary>
        /// Occurs when a new job run is available.
        /// </summary>
        event EventHandler<JobRunAvailableEventArgs> JobRunAvailable;

        /// <summary>
        /// Gets the machine operator.
        /// </summary>
        IMachineOperator MachineOperator { get; }

        /// <summary>
        /// Gets or sets the job designations of which the logger should log (supports multiple flags).
        /// </summary>
        JobDesignations JobDesignationFilter { get; set; }

        /// <summary>
        /// Gets or sets the job run source when logging job runs.
        /// </summary>
        JobSource JobSource { get; set; }

        /// <summary>
        /// Gets a value indicating whether this instance is started.
        /// </summary>
        bool IsStarted { get; }

        /// <summary>
        /// Starts the logger.
        /// </summary>
        void Start();

        /// <summary>
        /// Stops the logger.
        /// </summary>
        void Stop();

        /// <summary>
        /// Sets the head cleaning parameters.
        /// </summary>
        /// <param name="machine">The machine.</param>
        void SetDefaultMachine(Machine machine);
    }
}