ProcessProgressHandlerTUnit Class

Defines a delegate handler for a ProcessProgressTUnit instance.

Definition

Namespace: Gemstone
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.128 -- Release Build+d050cfc5563c89a1188cc3c6b2d417530856f490
public class ProcessProgressHandler<TUnit>
where TUnit : struct, new()
Inheritance
Object    ProcessProgressHandlerTUnit

Type Parameters

TUnit
Unit of progress used (long, double, int, etc.)

Remarks

This handler is used by methods with an Action delegate parameter (e.g., Action<ProcessProgress<long>>) providing a simple callback mechanism for reporting progress on a long operation.

Constructors

ProcessProgressHandlerTUnit(ActionProcessProgressTUnit, String) Constructs a new process progress handler for the specified parameters.
ProcessProgressHandlerTUnit(ActionProcessProgressTUnit, String, TUnit) Constructs a new process progress handler for the specified parameters.

Properties

Complete Gets or sets current process progress (i.e., number of units completed processing so far) - note that when this property value is assigned, the callback function is automatically called with updated ProcessProgressTUnit instance so consumer can track progress.
ProcessProgress Gets instance of ProcessProgressTUnit used to track progress for this handler.
ProgressHandler Gets or sets reference to delegate handler used as a callback to report process progress.
Total Gets or sets total number of units to be processed.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
UpdateProgress Calls callback function with updated ProcessProgressTUnit instance so consumer can track progress.

Extension Methods

GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)

See Also