ProcessProgressHandlerTUnit Class

Defines a delegate handler for a ProcessProgressTUnit instance.

Inheritance Hierarchy

SystemObject
GSFProcessProgressHandlerTUnit

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867

Syntax

C++

JavaScript

Copy

public class ProcessProgressHandler<TUnit>
where TUnit : struct, new()

Public Class ProcessProgressHandler(Of TUnit As {Structure, New})

generic<typename TUnit>
where TUnit : value class, gcnew()
public ref class ProcessProgressHandler

type ProcessProgressHandler<'TUnit when 'TUnit : struct, new()> = class end

JavaScript does not support generic types or methods.

View Source

Type Parameters

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

The ProcessProgressHandlerTUnit type exposes the following members.

Constructors

	Name	Description
	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.

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	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)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	UpdateProgress	Calls callback function with updated ProcessProgressTUnit instance so consumer can track progress.

Top

Extension Methods

	Name	Description
	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)

Top

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.

Examples include: Compress(Stream, Stream, CompressionStrength, ActionProcessProgressInt64), Encrypt(Stream, Stream, Byte, Byte, CipherStrength, ActionProcessProgressInt64) and Decrypt(Stream, Stream, Byte, Byte, CipherStrength, ActionProcessProgressInt64)

Reference

GSF Namespace