Lean  $LEAN_TAG$
Public Member Functions | Properties | List of all members
QuantConnect.Result Class Reference

Base class for backtesting and live results that packages result data. LiveResult BacktestResult More...

Inheritance diagram for QuantConnect.Result:
[legend]

Public Member Functions

 Result ()
 Creates new empty instance More...
 
 Result (BaseResultParameters parameters)
 Creates a new result from the given parameters More...
 

Properties

IDictionary< string, Chart > Charts [get, set]
 Charts updates for the live algorithm since the last result packet More...
 
IDictionary< int, Order > Orders [get, set]
 Order updates since the last result packet More...
 
List< OrderEvent > OrderEvents [get, set]
 OrderEvent updates since the last result packet More...
 
IDictionary< DateTime, decimal > ProfitLoss [get, set]
 Trade profit and loss information since the last algorithm result packet More...
 
IDictionary< string, string > Statistics [get, set]
 Statistics information sent during the algorithm operations. More...
 
IDictionary< string, string > RuntimeStatistics [get, set]
 Runtime banner/updating statistics in the title banner of the live algorithm GUI. More...
 
IDictionary< string, string > State [get, set]
 State of the result packet. More...
 
IDictionary< string, string > ServerStatistics [get, set]
 Server status information, including CPU/RAM usage, ect... More...
 
AlgorithmConfiguration AlgorithmConfiguration [get, set]
 The algorithm's configuration required for report generation More...
 

Detailed Description

Base class for backtesting and live results that packages result data. LiveResult BacktestResult

Definition at line 29 of file Result.cs.

Constructor & Destructor Documentation

◆ Result() [1/2]

QuantConnect.Result.Result ( )

Creates new empty instance

Definition at line 89 of file Result.cs.

◆ Result() [2/2]

QuantConnect.Result.Result ( BaseResultParameters  parameters)

Creates a new result from the given parameters

Definition at line 96 of file Result.cs.

Property Documentation

◆ Charts

IDictionary<string, Chart> QuantConnect.Result.Charts
getset

Charts updates for the live algorithm since the last result packet

Definition at line 35 of file Result.cs.

◆ Orders

IDictionary<int, Order> QuantConnect.Result.Orders
getset

Order updates since the last result packet

Definition at line 41 of file Result.cs.

◆ OrderEvents

List<OrderEvent> QuantConnect.Result.OrderEvents
getset

OrderEvent updates since the last result packet

Definition at line 47 of file Result.cs.

◆ ProfitLoss

IDictionary<DateTime, decimal> QuantConnect.Result.ProfitLoss
getset

Trade profit and loss information since the last algorithm result packet

Definition at line 53 of file Result.cs.

◆ Statistics

IDictionary<string, string> QuantConnect.Result.Statistics
getset

Statistics information sent during the algorithm operations.

Intended for update mode – send updates to the existing statistics in the result GUI. If statistic key does not exist in GUI, create it

Definition at line 60 of file Result.cs.

◆ RuntimeStatistics

IDictionary<string, string> QuantConnect.Result.RuntimeStatistics
getset

Runtime banner/updating statistics in the title banner of the live algorithm GUI.

Definition at line 66 of file Result.cs.

◆ State

IDictionary<string, string> QuantConnect.Result.State
getset

State of the result packet.

Definition at line 72 of file Result.cs.

◆ ServerStatistics

IDictionary<string, string> QuantConnect.Result.ServerStatistics
getset

Server status information, including CPU/RAM usage, ect...

Definition at line 78 of file Result.cs.

◆ AlgorithmConfiguration

AlgorithmConfiguration QuantConnect.Result.AlgorithmConfiguration
getset

The algorithm's configuration required for report generation

Definition at line 84 of file Result.cs.

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