Lean  $LEAN_TAG$
QuantConnect.Packets.BaseResultParameters Class Reference

Base parameters used by LiveResultParameters and BacktestResultParameters More...

Inheritance diagram for QuantConnect.Packets.BaseResultParameters:
[legend]

Public Member Functions

 BaseResultParameters (IDictionary< string, Chart > charts, IDictionary< int, Order > orders, IDictionary< DateTime, decimal > profitLoss, IDictionary< string, string > statistics, IDictionary< string, string > runtimeStatistics, List< OrderEvent > orderEvents, AlgorithmConfiguration algorithmConfiguration=null, IDictionary< string, string > state=null)
 Creates a new instance More...
 

Properties

IDictionary< DateTime, decimal > ProfitLoss [get, set]
 Trade profit and loss information since the last algorithm result packet More...
 
IDictionary< string, ChartCharts [get, set]
 Charts updates for the live algorithm since the last result packet More...
 
IDictionary< int, OrderOrders [get, set]
 Order updates since the last result packet More...
 
List< OrderEventOrderEvents [get, set]
 Order events updates since the last 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 information of the algorithm. More...
 
AlgorithmConfiguration AlgorithmConfiguration [get, set]
 The algorithm's configuration required for report generation More...
 

Detailed Description

Base parameters used by LiveResultParameters and BacktestResultParameters

Definition at line 26 of file BaseResultParameters.cs.

Constructor & Destructor Documentation

◆ BaseResultParameters()

QuantConnect.Packets.BaseResultParameters.BaseResultParameters ( IDictionary< string, Chart charts,
IDictionary< int, Order orders,
IDictionary< DateTime, decimal >  profitLoss,
IDictionary< string, string >  statistics,
IDictionary< string, string >  runtimeStatistics,
List< OrderEvent orderEvents,
AlgorithmConfiguration  algorithmConfiguration = null,
IDictionary< string, string >  state = null 
)

Creates a new instance

Definition at line 71 of file BaseResultParameters.cs.

Property Documentation

◆ ProfitLoss

IDictionary<DateTime, decimal> QuantConnect.Packets.BaseResultParameters.ProfitLoss
getset

Trade profit and loss information since the last algorithm result packet

Definition at line 31 of file BaseResultParameters.cs.

◆ Charts

IDictionary<string, Chart> QuantConnect.Packets.BaseResultParameters.Charts
getset

Charts updates for the live algorithm since the last result packet

Definition at line 36 of file BaseResultParameters.cs.

◆ Orders

IDictionary<int, Order> QuantConnect.Packets.BaseResultParameters.Orders
getset

Order updates since the last result packet

Definition at line 41 of file BaseResultParameters.cs.

◆ OrderEvents

List<OrderEvent> QuantConnect.Packets.BaseResultParameters.OrderEvents
getset

Order events updates since the last result packet

Definition at line 46 of file BaseResultParameters.cs.

◆ Statistics

IDictionary<string, string> QuantConnect.Packets.BaseResultParameters.Statistics
getset

Statistics information sent during the algorithm operations.

Definition at line 51 of file BaseResultParameters.cs.

◆ RuntimeStatistics

IDictionary<string, string> QuantConnect.Packets.BaseResultParameters.RuntimeStatistics
getset

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

Definition at line 56 of file BaseResultParameters.cs.

◆ State

IDictionary<string, string> QuantConnect.Packets.BaseResultParameters.State
getset

State information of the algorithm.

Definition at line 61 of file BaseResultParameters.cs.

◆ AlgorithmConfiguration

AlgorithmConfiguration QuantConnect.Packets.BaseResultParameters.AlgorithmConfiguration
getset

The algorithm's configuration required for report generation

Definition at line 66 of file BaseResultParameters.cs.


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