Click or drag to resize

IProgressReporterGetSubTask(Double, CancellationToken, CancellationToken) Method

Creates a nested task.

Namespace: Altaxo
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
Copy
IProgressReporter GetSubTask(
	double workAmount,
	CancellationToken cancellationTokenSoft,
	CancellationToken cancellationTokenHard
)

Parameters

workAmount  Double
The amount of work this sub-task performs in relation to the work of this task. That means, this parameter is used as a scaling factor for work performed within the subtask.
cancellationTokenSoft  CancellationToken
A cancellation token that can be used to cancel the sub-task, typically with incomplete, but not corrupted result. Note: cancelling the main task will not cancel the sub-task.
cancellationTokenHard  CancellationToken
A cancellation token that can be used to hard cancel the sub-task, typically with corrupted result. Note: cancelling the main task will cancel the sub-task.

Return Value

IProgressReporter
A new progress monitor representing the sub-task. Multiple child progress monitors can be used at once; even concurrently on multiple threads.
See Also