IProgress |
Allows a thread to report text to a receiver. Additionally, the thread can use the properties
CancellationPending, CancellationToken, and CancellationTokenHard
to end the task in a safe way.
Namespace: Altaxo
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public interface IProgressReporter : IProgress<double>, IProgress<string>, IProgress<(string , double )>, IDisposable
The IProgressReporter type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CancellationPending | Returns true if the activity was cancelled by the user. The script has to check this value periodically. If it is set to true, the script should return. |
| CancellationToken | Gets the cancellation token (soft). Typical use of the soft cancellation token is to interrupt some work, without compromising the result (the result typically is incomplete, but not corrupted). |
| CancellationTokenHard | Gets the cancellation token (hard). Typical use of the hard cancellation token is to abort some work, with corrupting the result. If the result is not corrupted, then use the . |
| ShouldReportNow | True if we should report the progress now. The progress can be reported at any time, but if the evaluation of the progress is costing, then this flag should be viewed first. |
| TaskName | Gets/Sets the name to show while the task is active. |
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| GetSubTask(Double) | Creates a nested task. |
| GetSubTask(Double, CancellationToken, CancellationToken) | Creates a nested task. |
| Report(T) | Reports a progress update. (Inherited from IProgressDouble) |
| Report(T) | (Inherited from IProgressString) |
| Report(T) | (Inherited from IProgressValueTupleString, Double) |
| ReportProgress(String) | Reports the progress as a text string. |
| ReportProgress(String, Double) | Reports the progress as a text string. |
| ReportStatus | Sets the operation status. Note: the status of the whole operation is the most severe status of all nested monitors. The more severe value persists even if the child monitor gets disposed. |
See Also