QuantConnect.Packets.BacktestNodePacket Class Reference
Algorithm backtest task information packet. More...
Inheritance diagram for QuantConnect.Packets.BacktestNodePacket:
Public Member Functions | |
| BacktestNodePacket () | |
| Default constructor for JSON More... | |
| BacktestNodePacket (int userId, int projectId, string sessionId, byte[] algorithmData, decimal startingCapital, string name) | |
| Initialize the backtest task packet. More... | |
| BacktestNodePacket (int userId, int projectId, string sessionId, byte[] algorithmData, string name, CashAmount? startingCapital=null) | |
| Initialize the backtest task packet. More... | |
 Public Member Functions inherited from QuantConnect.Packets.AlgorithmNodePacket | |
| AlgorithmNodePacket (PacketType type) | |
| Default constructor for the algorithm node: More... | |
| string | GetAlgorithmName () |
| Gets a unique name for the algorithm defined by this packet More... | |
| Public Member Functions inherited from QuantConnect.Packets.Packet | |
| Packet (PacketType type) | |
| Initialize the base class and setup the packet type. More... | |
Properties | |
| string | Name = string.Empty [get, set] |
| Name of the backtest as randomly defined in the IDE. More... | |
| string | BacktestId = DefaultId [get, set] |
| BacktestId / Algorithm Id for this task More... | |
| string | OptimizationId [get, set] |
| Optimization Id for this task More... | |
| DateTime? | PeriodStart [get, set] |
| Backtest start-date as defined in the Initialize() method. More... | |
| DateTime? | PeriodFinish [get, set] |
| Backtest end date as defined in the Initialize() method. More... | |
| DateTime? | OutOfSampleMaxEndDate [get, set] |
| Backtest maximum end date More... | |
| int | OutOfSampleDays [get, set] |
| The backtest out of sample day count More... | |
| int | TradeableDates [get, set] |
| Estimated number of trading days in this backtest task based on the start-end dates. More... | |
| bool | Debugging [get, set] |
| True, if this is a debugging backtest More... | |
| CashAmount? | CashAmount [get, set] |
| Optional initial cash amount if set More... | |
| override AlgorithmMode? | AlgorithmMode [get] |
| Algorithm running mode. More... | |
| Properties inherited from QuantConnect.Packets.AlgorithmNodePacket | |
| string | HostName [get, set] |
| The host name to use if any More... | |
| int | UserId [get, set] |
| User Id placing request More... | |
| string | UserToken = string.Empty [get, set] |
| User API Token. | |
| string | OrganizationId = string.Empty [get, set] |
| User Organization Id. | |
| int | ProjectId [get, set] |
| Project Id of the request More... | |
| string | ProjectName [get, set] |
| Project name of the request More... | |
| string | AlgorithmId [get] |
| Algorithm Id - BacktestId or DeployId - Common Id property between packets. More... | |
| string | SessionId = string.Empty [get, set] |
| User session Id for authentication More... | |
| Language | Language = Language.CSharp [get, set] |
| Language flag: Currently represents IL code or Dynamic Scripted Types. More... | |
| ServerType | ServerType = ServerType.Server512 [get, set] |
| Server type for the deployment (512, 1024, 2048) More... | |
| string | CompileId = string.Empty [get, set] |
| Unique compile id of this backtest More... | |
| string | Version [get, set] |
| Version number identifier for the lean engine. More... | |
| bool | Redelivered [get, set] |
| An algorithm packet which has already been run and is being redelivered on this node. In this event we don't want to relaunch the task as it may result in unexpected behaviour for user. More... | |
| byte[] | Algorithm = Array.Empty<byte>() [get, set] |
| Algorithm binary with zip of contents More... | |
| string | RequestSource = "WebIDE" [get, set] |
| Request source - Web IDE or API - for controling result handler behaviour More... | |
| int??? | RamAllocation [get] |
| The maximum amount of RAM (in MB) this algorithm is allowed to utilize More... | |
| Controls | Controls [get, set] |
| Specifies values to control algorithm limits More... | |
| Dictionary< string, string > | Parameters = new Dictionary<string [get, set] |
| The parameter values used to set algorithm parameters More... | |
| string | HistoryProvider = string.Empty [get, set] |
| String name of the HistoryProvider we're running with More... | |
| virtual AlgorithmMode | AlgorithmMode = AlgorithmMode.Backtesting [get] |
| Algorithm running mode. More... | |
| DeploymentTarget | DeploymentTarget [get, set] |
| Deployment target, either local or cloud. More... | |
| Properties inherited from QuantConnect.Packets.PythonEnvironmentPacket | |
| string | PythonVirtualEnvironment [get, set] |
| Virtual environment ID used to find PythonEvironments Ideally MD5, but environment names work as well. More... | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from QuantConnect.Packets.PythonEnvironmentPacket | |
| PythonEnvironmentPacket (PacketType type) | |
| Default constructor for a PythonEnvironmentPacket More... | |
Detailed Description
Algorithm backtest task information packet.
Definition at line 28 of file BacktestNodePacket.cs.
Constructor & Destructor Documentation
◆ BacktestNodePacket() [1/3]
| QuantConnect.Packets.BacktestNodePacket.BacktestNodePacket | ( | ) |
Default constructor for JSON
Definition at line 99 of file BacktestNodePacket.cs.
◆ BacktestNodePacket() [2/3]
| QuantConnect.Packets.BacktestNodePacket.BacktestNodePacket | ( | int | userId, |
| int | projectId, | ||
| string | sessionId, | ||
| byte[] | algorithmData, | ||
| decimal | startingCapital, | ||
| string | name | ||
| ) |
Initialize the backtest task packet.
Definition at line 113 of file BacktestNodePacket.cs.
◆ BacktestNodePacket() [3/3]
| QuantConnect.Packets.BacktestNodePacket.BacktestNodePacket | ( | int | userId, |
| int | projectId, | ||
| string | sessionId, | ||
| byte[] | algorithmData, | ||
| string | name, | ||
| CashAmount? | startingCapital = null |
||
| ) |
Initialize the backtest task packet.
Definition at line 121 of file BacktestNodePacket.cs.
Property Documentation
◆ Name
|
getset |
Name of the backtest as randomly defined in the IDE.
Definition at line 37 of file BacktestNodePacket.cs.
◆ BacktestId
|
getset |
BacktestId / Algorithm Id for this task
Definition at line 42 of file BacktestNodePacket.cs.
◆ OptimizationId
|
getset |
Optimization Id for this task
Definition at line 47 of file BacktestNodePacket.cs.
◆ PeriodStart
|
getset |
Backtest start-date as defined in the Initialize() method.
Definition at line 52 of file BacktestNodePacket.cs.
◆ PeriodFinish
|
getset |
Backtest end date as defined in the Initialize() method.
Definition at line 57 of file BacktestNodePacket.cs.
◆ OutOfSampleMaxEndDate
|
getset |
Backtest maximum end date
Definition at line 62 of file BacktestNodePacket.cs.
◆ OutOfSampleDays
|
getset |
The backtest out of sample day count
Definition at line 67 of file BacktestNodePacket.cs.
◆ TradeableDates
|
getset |
Estimated number of trading days in this backtest task based on the start-end dates.
Definition at line 72 of file BacktestNodePacket.cs.
◆ Debugging
|
getset |
True, if this is a debugging backtest
Definition at line 77 of file BacktestNodePacket.cs.
◆ CashAmount
|
getset |
Optional initial cash amount if set
Definition at line 82 of file BacktestNodePacket.cs.
◆ AlgorithmMode
|
get |
Algorithm running mode.
Definition at line 89 of file BacktestNodePacket.cs.
The documentation for this class was generated from the following file:
- Common/Packets/BacktestNodePacket.cs
