Algorithm Node Packet is a work task for the Lean Engine More...

Inheritance diagram for QuantConnect.Packets.AlgorithmNodePacket:

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...

Properties
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 Node Packet is a work task for the Lean Engine

Definition at line 27 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 33 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 160 of file AlgorithmNodePacket.cs.

Property Documentation

◆ HostName

string QuantConnect.Packets.AlgorithmNodePacket.HostName

getset

The host name to use if any

Definition at line 40 of file AlgorithmNodePacket.cs.

◆ UserId

int QuantConnect.Packets.AlgorithmNodePacket.UserId

getset

User Id placing request

Definition at line 45 of file AlgorithmNodePacket.cs.

◆ ProjectId

int QuantConnect.Packets.AlgorithmNodePacket.ProjectId

getset

Project Id of the request

Definition at line 56 of file AlgorithmNodePacket.cs.

◆ ProjectName

string QuantConnect.Packets.AlgorithmNodePacket.ProjectName

getset

Project name of the request

Definition at line 61 of file AlgorithmNodePacket.cs.

◆ AlgorithmId

string QuantConnect.Packets.AlgorithmNodePacket.AlgorithmId

get

Algorithm Id - BacktestId or DeployId - Common Id property between packets.

Definition at line 67 of file AlgorithmNodePacket.cs.

◆ SessionId

string QuantConnect.Packets.AlgorithmNodePacket.SessionId = string.Empty

getset

User session Id for authentication

Definition at line 85 of file AlgorithmNodePacket.cs.

◆ Language

Language QuantConnect.Packets.AlgorithmNodePacket.Language = Language.CSharp

getset

Language flag: Currently represents IL code or Dynamic Scripted Types.

Definition at line 90 of file AlgorithmNodePacket.cs.

◆ ServerType

ServerType QuantConnect.Packets.AlgorithmNodePacket.ServerType = ServerType.Server512

getset

Server type for the deployment (512, 1024, 2048)

Definition at line 95 of file AlgorithmNodePacket.cs.

◆ CompileId

string QuantConnect.Packets.AlgorithmNodePacket.CompileId = string.Empty

getset

Unique compile id of this backtest

Definition at line 100 of file AlgorithmNodePacket.cs.

◆ Version

string QuantConnect.Packets.AlgorithmNodePacket.Version

getset

Version number identifier for the lean engine.

Definition at line 105 of file AlgorithmNodePacket.cs.

◆ Redelivered

bool QuantConnect.Packets.AlgorithmNodePacket.Redelivered

getset

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 111 of file AlgorithmNodePacket.cs.

◆ Algorithm

byte [] QuantConnect.Packets.AlgorithmNodePacket.Algorithm = Array.Empty<byte>()

getset

Algorithm binary with zip of contents

Definition at line 116 of file AlgorithmNodePacket.cs.

◆ RequestSource

string QuantConnect.Packets.AlgorithmNodePacket.RequestSource = "WebIDE"

getset

Request source - Web IDE or API - for controling result handler behaviour

Definition at line 121 of file AlgorithmNodePacket.cs.

◆ RamAllocation

int??? QuantConnect.Packets.AlgorithmNodePacket.RamAllocation

get

The maximum amount of RAM (in MB) this algorithm is allowed to utilize

Definition at line 126 of file AlgorithmNodePacket.cs.

◆ Controls

Controls QuantConnect.Packets.AlgorithmNodePacket.Controls

getset

Specifies values to control algorithm limits

Definition at line 133 of file AlgorithmNodePacket.cs.

◆ Parameters

Dictionary<string, string> QuantConnect.Packets.AlgorithmNodePacket.Parameters = new Dictionary<string

getset

The parameter values used to set algorithm parameters

Definition at line 138 of file AlgorithmNodePacket.cs.

◆ HistoryProvider

string QuantConnect.Packets.AlgorithmNodePacket.HistoryProvider = string.Empty

getset

String name of the HistoryProvider we're running with

Definition at line 143 of file AlgorithmNodePacket.cs.

◆ AlgorithmMode

virtual AlgorithmMode QuantConnect.Packets.AlgorithmNodePacket.AlgorithmMode = AlgorithmMode.Backtesting

get

Algorithm running mode.

Definition at line 149 of file AlgorithmNodePacket.cs.

◆ DeploymentTarget

DeploymentTarget QuantConnect.Packets.AlgorithmNodePacket.DeploymentTarget

getset

Deployment target, either local or cloud.

Definition at line 155 of file AlgorithmNodePacket.cs.

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

Common/Packets/AlgorithmNodePacket.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlgorithmNodePacket()

Member Function Documentation

◆ GetAlgorithmName()

Property Documentation

◆ HostName

◆ UserId

◆ ProjectId

◆ ProjectName

◆ AlgorithmId

◆ SessionId

◆ Language

◆ ServerType

◆ CompileId

◆ Version

◆ Redelivered

◆ Algorithm

◆ RequestSource

◆ RamAllocation

◆ Controls

◆ Parameters

◆ HistoryProvider

◆ AlgorithmMode

◆ DeploymentTarget