Lean  $LEAN_TAG$
Properties | List of all members
QuantConnect.Interfaces.IRegressionAlgorithmDefinition Interface Reference

Defines a C# algorithm as a regression algorithm to be run as part of the test suite. This interface also allows the algorithm to declare that it has versions in other languages that should yield identical results. More...

Properties

AlgorithmStatus AlgorithmStatus [get]
 Final status of the algorithm More...
 
bool CanRunLocally [get]
 This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm. More...
 
List< Language > Languages [get]
 This is used by the regression test system to indicate which languages this algorithm is written in. More...
 
long DataPoints [get]
 Data Points count of all timeslices of algorithm More...
 
int AlgorithmHistoryDataPoints [get]
 Data Points count of the algorithm history More...
 
Dictionary< string, string > ExpectedStatistics [get]
 This is used by the regression test system to indicate what the expected statistics are from running the algorithm More...
 

Detailed Description

Defines a C# algorithm as a regression algorithm to be run as part of the test suite. This interface also allows the algorithm to declare that it has versions in other languages that should yield identical results.

Definition at line 25 of file IRegressionAlgorithmDefinition.cs.

Property Documentation

◆ AlgorithmStatus

AlgorithmStatus QuantConnect.Interfaces.IRegressionAlgorithmDefinition.AlgorithmStatus
get

Final status of the algorithm

Definition at line 30 of file IRegressionAlgorithmDefinition.cs.

◆ CanRunLocally

bool QuantConnect.Interfaces.IRegressionAlgorithmDefinition.CanRunLocally
get

This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.

Definition at line 35 of file IRegressionAlgorithmDefinition.cs.

◆ Languages

List<Language> QuantConnect.Interfaces.IRegressionAlgorithmDefinition.Languages
get

This is used by the regression test system to indicate which languages this algorithm is written in.

Definition at line 40 of file IRegressionAlgorithmDefinition.cs.

◆ DataPoints

long QuantConnect.Interfaces.IRegressionAlgorithmDefinition.DataPoints
get

Data Points count of all timeslices of algorithm

Definition at line 45 of file IRegressionAlgorithmDefinition.cs.

◆ AlgorithmHistoryDataPoints

int QuantConnect.Interfaces.IRegressionAlgorithmDefinition.AlgorithmHistoryDataPoints
get

Data Points count of the algorithm history

Definition at line 50 of file IRegressionAlgorithmDefinition.cs.

◆ ExpectedStatistics

Dictionary<string, string> QuantConnect.Interfaces.IRegressionAlgorithmDefinition.ExpectedStatistics
get

This is used by the regression test system to indicate what the expected statistics are from running the algorithm

Definition at line 55 of file IRegressionAlgorithmDefinition.cs.

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