aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/PPC/Tango.PPC.Common/MachineUpdate/IMachineUpdateManager.cs
blob: 7c835165ff1aeaeac5968fa56939fa4ab3aaae1d (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.PMR.Synchronization;
using Tango.PPC.Common.Publish;
using Tango.PPC.Common.UpdatePackages;
using Tango.PPC.Common.Web;

namespace Tango.PPC.Common.MachineUpdate
{
    public interface IMachineUpdateManager
    {
        /// <summary>
        /// Occurs when an application update is available.
        /// </summary>
        event EventHandler<CheckForUpdateResponse> UpdateAvailable;

        /// <summary>
        /// Gets or sets a value indicating whether to automatically check for new application updates.
        /// </summary>
        bool EnableAutoCheckForUpdates { get; set; }

        /// <summary>
        /// Gets the current machine update progress status.
        /// </summary>
        MachineUpdateProgress Status { get; }

        /// <summary>
        /// Occurs when there is a text log message available.
        /// </summary>
        event EventHandler<String> ProgressLog;

        /// <summary>
        /// Occurs when the update has made some progress.
        /// </summary>
        event EventHandler<MachineUpdateProgress> Progress;

        /// <summary>
        /// Performs a machine update.
        /// </summary>
        /// <param name="setupFirmware">if set to <c>true</c> updates the embedded device firmware.</param>
        /// <param name="setupFPGA">if set to <c>true</c> updates the embedded device FPGA version and other parameters.</param>
        /// <returns></returns>
        Task<MachineUpdateResult> Update(bool setupFirmware, bool setupFPGA);

        /// <summary>
        /// Performs a machine update using the specified software update package path.
        /// </summary>
        /// <param name="fileName">Name of the file.</param>
        /// <returns></returns>
        Task<MachineUpdateResult> UpdateFromTUP(String fileName, bool setupFirmware, bool setupFPGA);

        /// <summary>
        /// Performs a firmware upgrade from the specified TFP file.
        /// </summary>
        /// <param name="fileName">Name of the file.</param>
        /// <returns></returns>
        Task UpdateFromTFP(String fileName);

        /// <summary>
        /// Checks if any update are available.
        /// </summary>
        /// <returns></returns>
        Task<CheckForUpdateResponse> CheckForUpdate();

        /// <summary>
        /// Checks whether it is necessary to updates all the "overwrite-able" database tables.
        /// </summary>
        /// <returns></returns>
        Task<DbCompareResult> UpdateDBCheck();

        /// <summary>
        /// Updates all the "overwrite-able" database tables.
        /// </summary>
        /// <returns></returns>
        Task UpdateDB(DbCompareResult dbCompareResult);

        /// <summary>
        /// Gets the update package file information.
        /// </summary>
        /// <param name="filePath">The file path.</param>
        /// <returns></returns>
        Task<PublishInfo> GetUpdatePackageFileInfo(String filePath);

        /// <summary>
        /// Checks whether any post update packages needs to be installed.
        /// </summary>
        /// <returns></returns>
        Task<bool> PostUpdatePackagesRequired();

        /// <summary>
        /// Runs all post update packages.
        /// </summary>
        /// <returns></returns>
        Task<PackageRunnerResult> RunPostUpdatePackages();

        /// <summary>
        /// Restores the last database backup.
        /// </summary>
        /// <returns></returns>
        Task RestoreLastDatabaseBackup();
    }
}