Files
FSI.BT.IR.Tools/FSI.Lib/Tools/RoboSharp/Interfaces/IProgressEstimator.cs
maier_S 907ad039c4 Squashed 'FSI.Lib/' changes from 6aa4846..4a27cd3
4a27cd3 RoboSharp eingefügt
1b2fc1f Erweiterungsmethode für Startparameter einefügt

git-subtree-dir: FSI.Lib
git-subtree-split: 4a27cd377a1959dc669625473b018e42c31ef147
2022-03-23 14:17:56 +01:00

46 lines
1.7 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using FSI.Lib.Tools.RoboSharp.Results;
namespace FSI.Lib.Tools.RoboSharp.Interfaces
{
/// <summary>
/// Object that provides <see cref="IStatistic"/> objects whose events can be bound to report estimated RoboCommand / RoboQueue progress periodically.
/// </summary>
/// <remarks>
/// <see href="https://github.com/tjscience/RoboSharp/wiki/IProgressEstimator"/>
/// </remarks>
public interface IProgressEstimator : IResults
{
/// <summary>
/// Estimate of current number of directories processed while the job is still running. <br/>
/// Estimate is provided by parsing of the LogLines produces by RoboCopy.
/// </summary>
new IStatistic DirectoriesStatistic { get; }
/// <summary>
/// Estimate of current number of files processed while the job is still running. <br/>
/// Estimate is provided by parsing of the LogLines produces by RoboCopy.
/// </summary>
new IStatistic FilesStatistic { get; }
/// <summary>
/// Estimate of current number of bytes processed while the job is still running. <br/>
/// Estimate is provided by parsing of the LogLines produces by RoboCopy.
/// </summary>
new IStatistic BytesStatistic { get; }
/// <summary>
/// Parse this object's stats into a <see cref="RoboCopyExitCodes"/> enum.
/// </summary>
RoboCopyExitCodes GetExitCode();
/// <summary> Event that occurs when this IProgressEstimatorObject's IStatistic values have been updated. </summary>
event ProgressEstimator.UIUpdateEventHandler ValuesUpdated;
}
}