Algorithm Node Packet is a work task for the Lean Engine More...
Public Member Functions | |
| 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... | |
Public Attributes | |
| string | HostName |
| The host name to use if any More... | |
| int | UserId = 0 |
| User Id placing request More... | |
| string | UserToken = "" |
| User API Token. | |
| string | OrganizationId = "" |
| User Organization Id. | |
| int | ProjectId = 0 |
| Project Id of the request More... | |
| string | ProjectName |
| Project name of the request More... | |
| string | SessionId = "" |
| User session Id for authentication More... | |
| Language | Language = Language.CSharp |
| Language flag: Currently represents IL code or Dynamic Scripted Types. More... | |
| ServerType | ServerType = ServerType.Server512 |
| Server type for the deployment (512, 1024, 2048) More... | |
| string | CompileId = "" |
| Unique compile id of this backtest More... | |
| string | Version |
| Version number identifier for the lean engine. More... | |
| bool | Redelivered = false |
| 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 = new byte[] { } |
| Algorithm binary with zip of contents More... | |
| string | RequestSource = "WebIDE" |
| Request source - Web IDE or API - for controling result handler behaviour More... | |
| Controls | Controls |
| Specifies values to control algorithm limits More... | |
| Dictionary< string, string > | Parameters = new Dictionary<string, string>() |
| The parameter values used to set algorithm parameters More... | |
| string | HistoryProvider = "" |
| String name of the HistoryProvider we're running with More... | |
| DeploymentTarget | DeploymentTarget |
| Deployment target, either local or cloud. More... | |
Properties | |
| string | AlgorithmId [get] |
| Algorithm Id - BacktestId or DeployId - Common Id property between packets. More... | |
| int | RamAllocation [get] |
| The maximum amount of RAM (in MB) this algorithm is allowed to utilize More... | |
| virtual AlgorithmMode | AlgorithmMode = AlgorithmMode.Backtesting [get] |
| Algorithm running mode. 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 Node Packet is a work task for the Lean Engine
Definition at line 26 of file AlgorithmNodePacket.cs.
Constructor & Destructor Documentation
◆ AlgorithmNodePacket()
| QuantConnect.Packets.AlgorithmNodePacket.AlgorithmNodePacket | ( | PacketType | type | ) |
Default constructor for the algorithm node:
- Parameters
-
type
Definition at line 32 of file AlgorithmNodePacket.cs.
Member Function Documentation
◆ GetAlgorithmName()
| string QuantConnect.Packets.AlgorithmNodePacket.GetAlgorithmName | ( | ) |
Gets a unique name for the algorithm defined by this packet
Definition at line 174 of file AlgorithmNodePacket.cs.
Member Data Documentation
◆ HostName
| string QuantConnect.Packets.AlgorithmNodePacket.HostName |
The host name to use if any
Definition at line 40 of file AlgorithmNodePacket.cs.
◆ UserId
| int QuantConnect.Packets.AlgorithmNodePacket.UserId = 0 |
User Id placing request
Definition at line 46 of file AlgorithmNodePacket.cs.
◆ ProjectId
| int QuantConnect.Packets.AlgorithmNodePacket.ProjectId = 0 |
Project Id of the request
Definition at line 60 of file AlgorithmNodePacket.cs.
◆ ProjectName
| string QuantConnect.Packets.AlgorithmNodePacket.ProjectName |
Project name of the request
Definition at line 66 of file AlgorithmNodePacket.cs.
◆ SessionId
| string QuantConnect.Packets.AlgorithmNodePacket.SessionId = "" |
User session Id for authentication
Definition at line 88 of file AlgorithmNodePacket.cs.
◆ Language
| Language QuantConnect.Packets.AlgorithmNodePacket.Language = Language.CSharp |
Language flag: Currently represents IL code or Dynamic Scripted Types.
Definition at line 94 of file AlgorithmNodePacket.cs.
◆ ServerType
| ServerType QuantConnect.Packets.AlgorithmNodePacket.ServerType = ServerType.Server512 |
Server type for the deployment (512, 1024, 2048)
Definition at line 100 of file AlgorithmNodePacket.cs.
◆ CompileId
| string QuantConnect.Packets.AlgorithmNodePacket.CompileId = "" |
Unique compile id of this backtest
Definition at line 106 of file AlgorithmNodePacket.cs.
◆ Version
| string QuantConnect.Packets.AlgorithmNodePacket.Version |
Version number identifier for the lean engine.
Definition at line 112 of file AlgorithmNodePacket.cs.
◆ Redelivered
| bool QuantConnect.Packets.AlgorithmNodePacket.Redelivered = false |
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.
Definition at line 119 of file AlgorithmNodePacket.cs.
◆ Algorithm
| byte [] QuantConnect.Packets.AlgorithmNodePacket.Algorithm = new byte[] { } |
Algorithm binary with zip of contents
Definition at line 125 of file AlgorithmNodePacket.cs.
◆ RequestSource
| string QuantConnect.Packets.AlgorithmNodePacket.RequestSource = "WebIDE" |
Request source - Web IDE or API - for controling result handler behaviour
Definition at line 131 of file AlgorithmNodePacket.cs.
◆ Controls
| Controls QuantConnect.Packets.AlgorithmNodePacket.Controls |
Specifies values to control algorithm limits
Definition at line 145 of file AlgorithmNodePacket.cs.
◆ Parameters
| Dictionary<string, string> QuantConnect.Packets.AlgorithmNodePacket.Parameters = new Dictionary<string, string>() |
The parameter values used to set algorithm parameters
Definition at line 151 of file AlgorithmNodePacket.cs.
◆ HistoryProvider
| string QuantConnect.Packets.AlgorithmNodePacket.HistoryProvider = "" |
String name of the HistoryProvider we're running with
Definition at line 157 of file AlgorithmNodePacket.cs.
◆ DeploymentTarget
| DeploymentTarget QuantConnect.Packets.AlgorithmNodePacket.DeploymentTarget |
Deployment target, either local or cloud.
Definition at line 169 of file AlgorithmNodePacket.cs.
Property Documentation
◆ AlgorithmId
|
get |
Algorithm Id - BacktestId or DeployId - Common Id property between packets.
Definition at line 73 of file AlgorithmNodePacket.cs.
◆ RamAllocation
|
get |
The maximum amount of RAM (in MB) this algorithm is allowed to utilize
Definition at line 137 of file AlgorithmNodePacket.cs.
◆ AlgorithmMode
|
get |
Algorithm running mode.
Definition at line 163 of file AlgorithmNodePacket.cs.
The documentation for this class was generated from the following file:
- Common/Packets/AlgorithmNodePacket.cs
