Lean  $LEAN_TAG$
QuantConnect.Statistics.IStatisticsService Interface Reference

This interface exposes methods for accessing algorithm statistics results at runtime. More...

Inheritance diagram for QuantConnect.Statistics.IStatisticsService:
[legend]

Public Member Functions

StatisticsResults StatisticsResults ()
 Calculates and gets the current statistics for the algorithm More...
 
void SetSummaryStatistic (string name, string value)
 Sets or updates a custom summary statistic More...
 

Detailed Description

This interface exposes methods for accessing algorithm statistics results at runtime.

Definition at line 24 of file IStatisticsService.cs.

Member Function Documentation

◆ StatisticsResults()

StatisticsResults QuantConnect.Statistics.IStatisticsService.StatisticsResults ( )

Calculates and gets the current statistics for the algorithm

Returns
The current statistics

Implemented in QuantConnect.Lean.Engine.Results.LiveTradingResultHandler, and QuantConnect.Lean.Engine.Results.BacktestingResultHandler.

◆ SetSummaryStatistic()

void QuantConnect.Statistics.IStatisticsService.SetSummaryStatistic ( string  name,
string  value 
)

Sets or updates a custom summary statistic

Parameters
nameThe statistic name
valueThe statistic value

Implemented in QuantConnect.Lean.Engine.Results.LiveTradingResultHandler, and QuantConnect.Lean.Engine.Results.BacktestingResultHandler.


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