DimonSmart.Utils.Progress 1.25409.808

DimonSmart.Progress

Advanced Progress Indicator for .NET Applications

Overview

DimonSmart.Progress is a .NET library providing an advanced progress indicator that helps track, measure, and estimate completion times for long-running operations. Unlike simple progress bars, this indicator can measure individual subtasks and provide accurate time estimates based on actual performance.

Features

• Progress Tracking: Monitor the progress of long-running loops with accurate item counting
• Subtask Measurement: Measure and analyze the time taken by different components of your process
• Estimated Completion Time: Get real-time predictions of when the entire operation will finish
• Performance Analysis: Calculate average times for individual subtasks and iterations
• Sliding Window Analysis: Get more accurate time estimates by using recent iterations (rather than all iterations) for calculations

Installation

dotnet add package DimonSmart.Utils.Progress

Usage

Basic Example

// Initialize with the total number of items to process and optional window size
using var progress = new AdvancedProgressIndicator(totalItems: 1000, windowSize: 10);

// Process items in a loop
for (int i = 0; i < 1000; i++)
{
    // Measure a specific subtask
    using (progress.BeginSubTask("DataProcessing"))
    {
        // Perform your operation here
        ProcessData(data);
    }
    
    // Optionally measure another subtask in the same iteration
    using (progress.BeginSubTask("FileSaving"))
    {
        // Perform another operation
        SaveResults(result);
    }
    
    // Update the progress counter after completing an iteration
    progress.Update();
    
    // Optionally display progress information
    Console.WriteLine($"Processed: {i+1}/1000");
    if (progress.EstimatedEndTime.HasValue)
        Console.WriteLine($"Estimated completion: {progress.EstimatedEndTime.Value}");
    Console.WriteLine($"Effective average time per item: {progress.EffectiveAverageItemTime}");
}

Getting Timing Information

You can retrieve timing information for specific subtasks:

TimeSpan dataProcessingTime = progress.GetTaskTime("DataProcessing");
TimeSpan fileSavingTime = progress.GetTaskTime("FileSaving");

Console.WriteLine($"Average data processing time: {dataProcessingTime}");
Console.WriteLine($"Average file saving time: {fileSavingTime}");

API Reference

AdvancedProgressIndicator

The main class providing progress tracking functionality.

Constructor

• AdvancedProgressIndicator(int totalItems, int windowSize = 10) - Initialize with the total number of items to process and optional sliding window size

Properties

• ItemsLeft - Number of items remaining to be processed
• OverallAverageItemTime - Average time per iteration based on all processed items
• SlidingAverageItemTime - Average time per iteration based on the most recent iterations (window size)
• EffectiveAverageItemTime - The actual average used for time estimates (uses sliding average if available)
• EstimatedEndTime - Projected completion time based on the sliding window average time. Returns null if there's not enough data in the sliding window.

Methods

• Update() - Increment the processed items count and update sliding window time measurements
• BeginSubTask(string taskName) - Start timing a specific subtask (returns IDisposable)
• GetTaskTime(string taskName) - Get average execution time for a specific subtask

License

This project is licensed under the 0BSD License - see the LICENSE file for details.

Repository

https://github.com/DimonSmart/Progress