Files
2026-07-13 13:02:50 +08:00

124 lines
4.7 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using Newtonsoft.Json;
using QuantConnect.Orders;
using QuantConnect.Packets;
using QuantConnect.Statistics;
using System;
using System.Collections.Generic;
namespace QuantConnect
{
/// <summary>
/// Base class for backtesting and live results that packages result data.
/// <see cref="LiveResult"/>
/// <see cref="BacktestResult"/>
/// </summary>
public class Result
{
/// <summary>
/// Charts updates for the live algorithm since the last result packet
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, Chart> Charts { get; set; }
/// <summary>
/// Order updates since the last result packet
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<int, Order> Orders { get; set; }
/// <summary>
/// OrderEvent updates since the last result packet
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public List<OrderEvent> OrderEvents { get; set; }
/// <summary>
/// Trade profit and loss information since the last algorithm result packet
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<DateTime, decimal> ProfitLoss { get; set; }
/// <summary>
/// Statistics information sent during the algorithm operations.
/// </summary>
/// <remarks>Intended for update mode -- send updates to the existing statistics in the result GUI. If statistic key does not exist in GUI, create it</remarks>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, string> Statistics { get; set; }
/// <summary>
/// Runtime banner/updating statistics in the title banner of the live algorithm GUI.
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, string> RuntimeStatistics { get; set; }
/// <summary>
/// State of the result packet.
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, string> State { get; set; }
/// <summary>
/// Server status information, including CPU/RAM usage, ect...
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, string> ServerStatistics { get; set; }
/// <summary>
/// The algorithm's configuration required for report generation
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public AlgorithmConfiguration AlgorithmConfiguration { get; set; }
/// <summary>
/// Rolling window detailed statistics.
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public AlgorithmPerformance TotalPerformance { get; set; }
/// <summary>
/// Backtest analysis results.
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IReadOnlyList<Analysis> Analysis { get; set; }
/// <summary>
/// Creates new empty instance
/// </summary>
public Result()
{
}
/// <summary>
/// Creates a new result from the given parameters
/// </summary>
public Result(BaseResultParameters parameters)
{
Charts = parameters.Charts;
Orders = parameters.Orders;
ProfitLoss = parameters.ProfitLoss;
Statistics = parameters.Statistics;
RuntimeStatistics = parameters.RuntimeStatistics;
OrderEvents = parameters.OrderEvents;
AlgorithmConfiguration = parameters.AlgorithmConfiguration;
State = parameters.State;
TotalPerformance = parameters.TotalPerformance;
Analysis = parameters.Analysis;
}
}
}