Software/Visual_Studio/Tango.Integration/Operation/IGradientGenerationConfiguration.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
38
39
40

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.Entities;

namespace Tango.Integration.Operation
{
    /// <summary>
    /// Represents a <see cref="IMachineOperator"/> gradient steps generation configuration.
    /// </summary>
    public interface IGradientGenerationConfiguration
    {
        /// <summary>
        /// Gets or sets a value indicating whether to generate the gradient steps.
        /// </summary>
        bool IsEnabled { get; set; }

        /// <summary>
        /// Gets or sets the gradient steps resolution in centimeters.
        /// </summary>
        int ResolutionCM { get; set; }

        /// <summary>
        /// Creates a collection of brush stops representing the required gradient steps.
        /// </summary>
        /// <param name="segment">The segment.</param>
        /// <param name="job">The job</param>
        /// <param name="processParameters">The process parameters.</param>
        /// <param name="progress">Progress callback.</param>
        /// <returns></returns>
        List<BrushStop> Generate(Segment segment, Job job, ProcessParametersTable processParameters, Action<PreparingJobProgressEventArgs> progress = null);

        /// <summary>
        /// Aborts the current generation.
        /// </summary>
        void AbortCurrentGeneration();
    }
}