IProgressMonitor

Description

interface Tinman.Core.Threading.Operations.IProgressMonitor

Extended by

ProgressMonitor sealed

A IProgressMonitor object tracks the progress of a running operation.

Public / Methods

Error

2 overloads

public method Error1 → ()

returns → TinmanError

The last error or null if none.

Returns the last error that has been reported.

The last error will be reset to null.

public method Error2 → (1)

errorInfo in : TinmanError

[not-null]
The error info object.

Signals that a critical error has occurred and the operation has stopped.

Ticks​Finished

public method TicksFinished → (1)

ticks in : int64

[>=0]
The number of finished tick units.

The running operation has finished ticks in tick units.

Finished ticks should be reported only from within Run method.

Ticks​Pending

public method TicksPending → (1)

ticks in : int64

[>=0]
The number of upcoming tick units.

The running operation will last for another ticks in tick units.

Upcoming ticks should be reported as soon as possible in order to provide a believable progress indication.

Public / Attributes

Has​Error

public attribute HasError → (get)

value : bool

true if a critical error has been reported, false if not.

Has a critical error been reported via Error2?

Extensions

Normalize

public static method Normalize → (1)

ticks in : int64

[>=0]
The total number of ticks to report to this progress monitor.

returns → IProgressMonitor

The normalizing progress monitor.

Returns a progress monitor that will report its progress as a normalized value to this progress monitor.