TimedBackgroundMonitor Class

Provides a timer-driven progress reporter for background tasks.

Inheritance Hierarchy

SystemObject
Altaxo.Main.ServicesTimedBackgroundMonitor

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

Syntax

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

The TimedBackgroundMonitor type exposes the following members.

Constructors

	Name	Description
	TimedBackgroundMonitor	Initializes a new instance of the TimedBackgroundMonitor 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 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 .
	Progress	Gets or sets the current progress fraction.
	ProgressFraction	Gets or sets the latest progress fraction.
	ReportText	Gets or sets the latest progress text.
	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.
	Status	Gets or sets the current operation status.
	SynchronizingObject	Gets or sets the object used to marshal timer events to a specific thread.
	TaskName	Gets 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.
	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 nested task.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Report	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.
	Start	Starts the internal timer.
	Stop	Stops the internal timer.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	Elapsed	Occurs whenever the internal timer elapses.