|
Process
|
Represents current process progress for an operation.
Inheritance Hierarchy
Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax[SerializableAttribute] public class ProcessProgress<TUnit> where TUnit : struct, new()
Type Parameters
- TUnit
- Unit of progress used (long, double, int, etc.)
The ProcessProgressTUnit type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ProcessProgressTUnit(String) | Constructs a new instance of the ProcessProgressTUnit class using specified process name. |
| ProcessProgressTUnit(String, String, TUnit, TUnit) | Constructs a new instance of the ProcessProgressTUnit class using specified parameters. |
Properties| Name | Description | |
|---|---|---|
 | Complete | Gets or sets number of units completed processing so far. |
| ProcessName | Gets or sets name of process for which progress is being monitored. |
| ProgressMessage | Gets or sets current progress message (e.g., current file being copied, etc.) |
| Total | Gets or sets total number of units to be processed. |
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) |
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) |
Remarks
Used to track total progress of an identified operation.
See Also