Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.Results.BacktestProgressMonitor Class Reference

Monitors and reports the progress of a backtest More...

Public Member Functions

 BacktestProgressMonitor (ITimeKeeper timeKeeper, DateTime endUtcTime)
 Creates a new instance More...
 
void InvalidateProcessedDays ()
 Invalidates the processed days count value so it gets recalculated next time it is needed More...
 

Properties

int TotalDays [get]
 Gets the total days the algorithm will run More...
 
int ProcessedDays [get]
 Gets the current days the algorithm has been running for More...
 
decimal Progress [get]
 Gets the current progress of the backtest More...
 

Detailed Description

Monitors and reports the progress of a backtest

Definition at line 26 of file BacktestProgressMonitor.cs.

Constructor & Destructor Documentation

◆ BacktestProgressMonitor()

QuantConnect.Lean.Engine.Results.BacktestProgressMonitor.BacktestProgressMonitor ( ITimeKeeper  timeKeeper,
DateTime  endUtcTime 
)

Creates a new instance

Parameters
timeKeeperThe time keeper to use
endUtcTimeThe end UTC time

Definition at line 78 of file BacktestProgressMonitor.cs.

Member Function Documentation

◆ InvalidateProcessedDays()

void QuantConnect.Lean.Engine.Results.BacktestProgressMonitor.InvalidateProcessedDays ( )

Invalidates the processed days count value so it gets recalculated next time it is needed

Definition at line 88 of file BacktestProgressMonitor.cs.

Here is the caller graph for this function:

Property Documentation

◆ TotalDays

int QuantConnect.Lean.Engine.Results.BacktestProgressMonitor.TotalDays
get

Gets the total days the algorithm will run

Definition at line 41 of file BacktestProgressMonitor.cs.

◆ ProcessedDays

int QuantConnect.Lean.Engine.Results.BacktestProgressMonitor.ProcessedDays
get

Gets the current days the algorithm has been running for

Definition at line 46 of file BacktestProgressMonitor.cs.

◆ Progress

decimal QuantConnect.Lean.Engine.Results.BacktestProgressMonitor.Progress
get

Gets the current progress of the backtest

Definition at line 69 of file BacktestProgressMonitor.cs.


The documentation for this class was generated from the following file: