Lean  $LEAN_TAG$
QuantConnect.Api.OptimizationBacktest Class Reference

OptimizationBacktest object from the QuantConnect.com API. More...

Public Member Functions

 OptimizationBacktest (ParameterSet parameterSet, string backtestId, string name)
 Creates a new instance More...
 

Properties

decimal Progress [get, set]
 Progress of the backtest as a percentage from 0-1 based on the days lapsed from start-finish. More...
 
string Name [get]
 The backtest name More...
 
string HostName [get, set]
 The backtest host name More...
 
string BacktestId [get]
 The backtest id More...
 
ParameterSet ParameterSet [get]
 Represent a combination as key value of parameters, i.e. order doesn't matter More...
 
IDictionary< string, string > Statistics [get, set]
 The backtest statistics results More...
 
CandlestickSeries Equity [get, set]
 The backtest equity chart series More...
 
int ExitCode [get, set]
 The exit code of this backtest More...
 
DateTime? OutOfSampleMaxEndDate [get, set]
 Backtest maximum end date More...
 
int OutOfSampleDays [get, set]
 The backtest out of sample day count More...
 
DateTime StartDate [get, set]
 The backtest start date More...
 
DateTime EndDate [get, set]
 The backtest end date More...
 

Detailed Description

OptimizationBacktest object from the QuantConnect.com API.

Definition at line 27 of file OptimizationBacktest.cs.

Constructor & Destructor Documentation

◆ OptimizationBacktest()

QuantConnect.Api.OptimizationBacktest.OptimizationBacktest ( ParameterSet  parameterSet,
string  backtestId,
string  name 
)

Creates a new instance

Parameters
parameterSetThe parameter set
backtestIdThe backtest id if any
nameThe backtest name

Definition at line 95 of file OptimizationBacktest.cs.

Property Documentation

◆ Progress

decimal QuantConnect.Api.OptimizationBacktest.Progress
getset

Progress of the backtest as a percentage from 0-1 based on the days lapsed from start-finish.

Definition at line 32 of file OptimizationBacktest.cs.

◆ Name

string QuantConnect.Api.OptimizationBacktest.Name
get

The backtest name

Definition at line 37 of file OptimizationBacktest.cs.

◆ HostName

string QuantConnect.Api.OptimizationBacktest.HostName
getset

The backtest host name

Definition at line 42 of file OptimizationBacktest.cs.

◆ BacktestId

string QuantConnect.Api.OptimizationBacktest.BacktestId
get

The backtest id

Definition at line 47 of file OptimizationBacktest.cs.

◆ ParameterSet

ParameterSet QuantConnect.Api.OptimizationBacktest.ParameterSet
get

Represent a combination as key value of parameters, i.e. order doesn't matter

Definition at line 52 of file OptimizationBacktest.cs.

◆ Statistics

IDictionary<string, string> QuantConnect.Api.OptimizationBacktest.Statistics
getset

The backtest statistics results

Definition at line 57 of file OptimizationBacktest.cs.

◆ Equity

CandlestickSeries QuantConnect.Api.OptimizationBacktest.Equity
getset

The backtest equity chart series

Definition at line 62 of file OptimizationBacktest.cs.

◆ ExitCode

int QuantConnect.Api.OptimizationBacktest.ExitCode
getset

The exit code of this backtest

Definition at line 67 of file OptimizationBacktest.cs.

◆ OutOfSampleMaxEndDate

DateTime? QuantConnect.Api.OptimizationBacktest.OutOfSampleMaxEndDate
getset

Backtest maximum end date

Definition at line 72 of file OptimizationBacktest.cs.

◆ OutOfSampleDays

int QuantConnect.Api.OptimizationBacktest.OutOfSampleDays
getset

The backtest out of sample day count

Definition at line 77 of file OptimizationBacktest.cs.

◆ StartDate

DateTime QuantConnect.Api.OptimizationBacktest.StartDate
getset

The backtest start date

Definition at line 82 of file OptimizationBacktest.cs.

◆ EndDate

DateTime QuantConnect.Api.OptimizationBacktest.EndDate
getset

The backtest end date

Definition at line 87 of file OptimizationBacktest.cs.


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