A class that can inform registered listeners about the percentage of iterated items of an enumerable. More...
Public Member Functions | |
| ProgressableEnumerable (IEnumerable< ItemType > enumerable, int numberOfElements) | |
| Creates a new instance for an existing enumerable. More... | |
| IEnumerator< ItemType > | GetEnumerator () |
| Fetches the enumerator. More... | |
 Public Member Functions inherited from Joutsen.Progress | |
| Progress (double total) | |
| Creates a new instance for a predefined total value. More... | |
| virtual void | Update (double completed) |
| Advances the progress to the value represented by @paramref completed. More... | |
| virtual void | Reset () |
| Resets the progress state for a restart. More... | |
| void | Dispose () |
| Frees bound resources. More... | |
Protected Attributes | |
| IEnumerable< ItemType > | enumerable |
| Protected Attributes inherited from Joutsen.Progress | |
| double | total |
| The total value that the process can reach. More... | |
| double | completed |
| The completed amount or current progress. More... | |
| String | description |
| The description of progress. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Joutsen.Progress | |
| void | FireProgressChanged (double completed, double total, double progress) |
| Informs the registered listeners about a change in progress. More... | |
| void | FireDescriptionChanged (string description) |
| Informs the registered listeners about a change in the description. More... | |
| Properties inherited from Joutsen.Progress | |
| String | Description [get, set] |
| The description of progress. More... | |
| Events inherited from Joutsen.Progress | |
| Action< double, double, double > | ProgressChanged |
| An event that informs listeners about a change in the progress. More... | |
| Action< String > | DescriptionChanged |
| An event that informs listeners about a change in the description. More... | |
Detailed Description
A class that can inform registered listeners about the percentage of iterated items of an enumerable.
- Since
- 0.4.1
Constructor & Destructor Documentation
◆ ProgressableEnumerable()
| Joutsen.ProgressableEnumerable< ItemType >.ProgressableEnumerable | ( | IEnumerable< ItemType > | enumerable, |
| int | numberOfElements | ||
| ) |
Creates a new instance for an existing enumerable.
- Parameters
-
enumerable the enumerable numerOfElements the total number of elements in the enumerable
Member Function Documentation
◆ GetEnumerator()
| IEnumerator< ItemType > Joutsen.ProgressableEnumerable< ItemType >.GetEnumerator | ( | ) |
Fetches the enumerator.
Member Data Documentation
◆ enumerable
|
protected |
