ExternalDrivenBackgroundMonitor Class

Background monitor that can be externally driven, for example by a timer, to set ShouldReportNow.

Inheritance Hierarchy

SystemObject
Altaxo.Main.ServicesExternalDrivenBackgroundMonitor
Altaxo.Main.ServicesExternalDrivenTimeReportMonitor

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

Syntax

public class ExternalDrivenBackgroundMonitor : IExternalDrivenBackgroundMonitor, 
	IProgressMonitor, INotifyPropertyChanged, IDisposable

The ExternalDrivenBackgroundMonitor type exposes the following members.

Constructors

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

Properties

	Name	Description
	IsDisposed	Gets a flag indicating whether this instance is disposed.
	Progress	Gets the progress. If the value changes, it must be notified through the INotifyPropertyChanged interface.
	ProgressAndETA	Gets the progress text including an estimated completion time, if possible.
	ShouldReportNow	Gets a value indicating whether the monitor should be queried for a progress update.
	ShouldSetShouldReportAutomatically	If true, ShouldReportNow is set automatically every time one of the properties (Progress, Text0, Text1, ..) is read.
	Status	Gets the overall status of the task.
	TaskName	Gets the name of the task.
	Text0	Gets the text at level 0. If the value changes, it must be notified through the INotifyPropertyChanged interface.
	Text1	Gets or sets the progress text on level 1.
	Text2	Gets or sets the progress text on level 2.

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)
	GetProgressReporter	Gets a progress reporter for this monitor.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NewMonitorAndReporter	Creates a new monitor together with a matching progress reporter.
	SetCancellationPendingHard	Sets a flag that tries to interrupt the task hardly. This will typically leave a corrupted result.
	SetCancellationPendingSoft	Sets a flag that tries to interrupt the task softly. This will typically leave an incomplete, but not corrupted result.
	SetShouldReportNow	Sets the ShouldReportNow flag to true to indicate that the worker thread should report its progress.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	PropertyChanged	Occurs when a property value changes.

Fields

	Name	Description
	_shouldReport	Indicates whether a progress update should be reported.