Backtest result packet: send backtest information to GUI for user consumption. More...
Public Member Functions | |
| BacktestResultPacket () | |
| Default constructor for JSON Serialization More... | |
| BacktestResultPacket (string json) | |
| Compose the packet from a JSON string: More... | |
| BacktestResultPacket (BacktestNodePacket job, BacktestResult results, DateTime endDate, DateTime startDate, decimal progress=1m) | |
| Compose result data packet - with tradable dates from the backtest job task and the partial result packet. More... | |
 Public Member Functions inherited from QuantConnect.Packets.Packet | |
| Packet (PacketType type) | |
| Initialize the base class and setup the packet type. More... | |
Static Public Member Functions | |
| static BacktestResultPacket | CreateEmpty (BacktestNodePacket job) |
| Creates an empty result packet, useful when the algorithm fails to initialize More... | |
Public Attributes | |
| int | UserId |
| User Id placing this task More... | |
| int | ProjectId |
| Project Id of the this task. More... | |
| string | SessionId = string.Empty |
| User Session Id More... | |
| string | BacktestId = string.Empty |
| BacktestId for this result packet More... | |
| string | OptimizationId |
| OptimizationId for this result packet if any More... | |
| string | CompileId = string.Empty |
| Compile Id for the algorithm which generated this result packet. More... | |
| DateTime | PeriodStart |
| Start of the backtest period as defined in Initialize() method. More... | |
| DateTime | PeriodFinish |
| End of the backtest period as defined in the Initialize() method. More... | |
| DateTime | DateRequested |
| DateTime (EST) the user requested this backtest. More... | |
| DateTime | DateFinished |
| DateTime (EST) when the backtest was completed. More... | |
| decimal | Progress |
| Progress of the backtest as a percentage from 0-1 based on the days lapsed from start-finish. More... | |
| string | Name = string.Empty |
| Name of this backtest. More... | |
| BacktestResult | Results = new () |
| Result data object for this backtest More... | |
| double | ProcessingTime |
| Processing time of the algorithm (from moment the algorithm arrived on the algorithm node) More... | |
| int | TradeableDates |
| Estimated number of tradeable days in the backtest based on the start and end date or the backtest More... | |
Additional Inherited Members | |
| Properties inherited from QuantConnect.Packets.Packet | |
| PacketType | Type = PacketType.None [get, set] |
| Packet type defined by a string enum More... | |
| virtual string | Channel = "" [get, set] |
| User unique specific channel endpoint to send the packets More... | |
Detailed Description
Backtest result packet: send backtest information to GUI for user consumption.
Definition at line 29 of file BacktestResultPacket.cs.
Constructor & Destructor Documentation
◆ BacktestResultPacket() [1/3]
| QuantConnect.Packets.BacktestResultPacket.BacktestResultPacket | ( | ) |
Default constructor for JSON Serialization
Definition at line 109 of file BacktestResultPacket.cs.
◆ BacktestResultPacket() [2/3]
| QuantConnect.Packets.BacktestResultPacket.BacktestResultPacket | ( | string | json | ) |
Compose the packet from a JSON string:
Definition at line 118 of file BacktestResultPacket.cs.
◆ BacktestResultPacket() [3/3]
| QuantConnect.Packets.BacktestResultPacket.BacktestResultPacket | ( | BacktestNodePacket | job, |
| BacktestResult | results, | ||
| DateTime | endDate, | ||
| DateTime | startDate, | ||
| decimal | progress = 1m |
||
| ) |
Compose result data packet - with tradable dates from the backtest job task and the partial result packet.
- Parameters
-
job Job that started this request results Results class for the Backtest job endDate The algorithms backtest end date startDate The algorithms backtest start date progress Progress of the packet. For the packet we assume progess of 100%.
Definition at line 160 of file BacktestResultPacket.cs.
Member Function Documentation
◆ CreateEmpty()
|
static |
Creates an empty result packet, useful when the algorithm fails to initialize
- Parameters
-
job The associated job packet
- Returns
- An empty result packet
Definition at line 190 of file BacktestResultPacket.cs.
Member Data Documentation
◆ UserId
| int QuantConnect.Packets.BacktestResultPacket.UserId |
User Id placing this task
Definition at line 34 of file BacktestResultPacket.cs.
◆ ProjectId
| int QuantConnect.Packets.BacktestResultPacket.ProjectId |
Project Id of the this task.
Definition at line 39 of file BacktestResultPacket.cs.
◆ SessionId
| string QuantConnect.Packets.BacktestResultPacket.SessionId = string.Empty |
User Session Id
Definition at line 44 of file BacktestResultPacket.cs.
◆ BacktestId
| string QuantConnect.Packets.BacktestResultPacket.BacktestId = string.Empty |
BacktestId for this result packet
Definition at line 49 of file BacktestResultPacket.cs.
◆ OptimizationId
| string QuantConnect.Packets.BacktestResultPacket.OptimizationId |
OptimizationId for this result packet if any
Definition at line 54 of file BacktestResultPacket.cs.
◆ CompileId
| string QuantConnect.Packets.BacktestResultPacket.CompileId = string.Empty |
Compile Id for the algorithm which generated this result packet.
Definition at line 59 of file BacktestResultPacket.cs.
◆ PeriodStart
| DateTime QuantConnect.Packets.BacktestResultPacket.PeriodStart |
Start of the backtest period as defined in Initialize() method.
Definition at line 64 of file BacktestResultPacket.cs.
◆ PeriodFinish
| DateTime QuantConnect.Packets.BacktestResultPacket.PeriodFinish |
End of the backtest period as defined in the Initialize() method.
Definition at line 69 of file BacktestResultPacket.cs.
◆ DateRequested
| DateTime QuantConnect.Packets.BacktestResultPacket.DateRequested |
DateTime (EST) the user requested this backtest.
Definition at line 74 of file BacktestResultPacket.cs.
◆ DateFinished
| DateTime QuantConnect.Packets.BacktestResultPacket.DateFinished |
DateTime (EST) when the backtest was completed.
Definition at line 79 of file BacktestResultPacket.cs.
◆ Progress
| decimal QuantConnect.Packets.BacktestResultPacket.Progress |
Progress of the backtest as a percentage from 0-1 based on the days lapsed from start-finish.
Definition at line 84 of file BacktestResultPacket.cs.
◆ Name
| string QuantConnect.Packets.BacktestResultPacket.Name = string.Empty |
Name of this backtest.
Definition at line 89 of file BacktestResultPacket.cs.
◆ Results
| BacktestResult QuantConnect.Packets.BacktestResultPacket.Results = new () |
Result data object for this backtest
Definition at line 94 of file BacktestResultPacket.cs.
◆ ProcessingTime
| double QuantConnect.Packets.BacktestResultPacket.ProcessingTime |
Processing time of the algorithm (from moment the algorithm arrived on the algorithm node)
Definition at line 99 of file BacktestResultPacket.cs.
◆ TradeableDates
| int QuantConnect.Packets.BacktestResultPacket.TradeableDates |
Estimated number of tradeable days in the backtest based on the start and end date or the backtest
Definition at line 104 of file BacktestResultPacket.cs.
The documentation for this class was generated from the following file:
- Common/Packets/BacktestResultPacket.cs
