Click or drag to resize

ProcessProgressTUnit Class

Represents current process progress for an operation.
Inheritance Hierarchy
SystemObject
  GSFProcessProgressTUnit

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8
Syntax
[SerializableAttribute]
public class ProcessProgress<TUnit>
where TUnit : struct, new()
View Source

Type Parameters

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

The ProcessProgressTUnit type exposes the following members.

Constructors
 NameDescription
Public methodProcessProgressTUnit(String) Constructs a new instance of the ProcessProgressTUnit class using specified process name.
Public methodProcessProgressTUnit(String, String, TUnit, TUnit) Constructs a new instance of the ProcessProgressTUnit class using specified parameters.
Top
Properties
 NameDescription
Public propertyComplete Gets or sets number of units completed processing so far.
Public propertyProcessName Gets or sets name of process for which progress is being monitored.
Public propertyProgressMessage Gets or sets current progress message (e.g., current file being copied, etc.)
Public propertyTotal Gets or sets total number of units to be processed.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
Remarks
Used to track total progress of an identified operation.
See Also

Reference

GSF Namespace