ExternalDrivenBackgroundMonitorReporter Class

Reports progress to an ExternalDrivenBackgroundMonitor and supports hierarchical subtasks.

Inheritance Hierarchy

SystemObject
Altaxo.Main.ServicesExternalDrivenBackgroundMonitorReporter

Namespace: Altaxo.Main.Services
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)

Syntax

public class Reporter : IProgressReporter, IProgress<double>, 
	IProgress<string>, IProgress<(string , double )>, 
	IDisposable

The ExternalDrivenBackgroundMonitorReporter type exposes the following members.

Constructors

	Name	Description
	ExternalDrivenBackgroundMonitorReporter	Initializes a new instance of the ExternalDrivenBackgroundMonitorReporter class.

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 hard-cancellation token.
	FractionOfWorkOfParent	The fraction of work the parent has assigned to this subtask.
	Level	Gets the nesting level of this reporter.
	Parent	Gets the parent reporter, or null if this is the root reporter.
	Root	Gets the root monitor that receives the aggregated progress.
	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 the name to show while the task is active.

Methods

	Name	Description
	CreateSubTask	Creates a named subtask.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	EhSubTaskReport	Is called from the child subtasks.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSubTask(Double)	Creates a nested task.
	GetSubTask(Double, CancellationToken, CancellationToken)	Creates a subtask with explicit cancellation tokens.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Report(Double)	Reports a progress update.
	Report(String)	Reports a progress update.
	Report(ValueTupleString, Double)	Reports a progress update.
	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.
	ToString	Returns a string that represents the current object. (Inherited from Object)