Lean  $LEAN_TAG$
QuantConnect.Packets.AlgorithmStatusPacket Class Reference

Algorithm status update information packet More...

Inheritance diagram for QuantConnect.Packets.AlgorithmStatusPacket:
[legend]

Public Member Functions

 AlgorithmStatusPacket ()
 Default constructor for JSON More...
 
 AlgorithmStatusPacket (string algorithmId, int projectId, AlgorithmStatus status, string message="")
 Initialize algorithm state 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

AlgorithmStatus Status
 Current algorithm status More...
 
string ChartSubscription
 Chart we're subscribed to for live trading. More...
 
string Message
 Optional message or reason for state change. More...
 
string AlgorithmId
 Algorithm Id associated with this status packet More...
 
string OptimizationId
 OptimizationId for this result packet if any More...
 
int ProjectId
 Project Id associated with this status packet More...
 
string ChannelStatus
 The current state of the channel 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

Algorithm status update information packet

Definition at line 25 of file AlgorithmStatusPacket.cs.

Constructor & Destructor Documentation

◆ AlgorithmStatusPacket() [1/2]

QuantConnect.Packets.AlgorithmStatusPacket.AlgorithmStatusPacket ( )

Default constructor for JSON

Definition at line 66 of file AlgorithmStatusPacket.cs.

◆ AlgorithmStatusPacket() [2/2]

QuantConnect.Packets.AlgorithmStatusPacket.AlgorithmStatusPacket ( string  algorithmId,
int  projectId,
AlgorithmStatus  status,
string  message = "" 
)

Initialize algorithm state packet:

Definition at line 74 of file AlgorithmStatusPacket.cs.

Member Data Documentation

◆ Status

AlgorithmStatus QuantConnect.Packets.AlgorithmStatusPacket.Status

Current algorithm status

Definition at line 31 of file AlgorithmStatusPacket.cs.

◆ ChartSubscription

string QuantConnect.Packets.AlgorithmStatusPacket.ChartSubscription

Chart we're subscribed to for live trading.

Definition at line 36 of file AlgorithmStatusPacket.cs.

◆ Message

string QuantConnect.Packets.AlgorithmStatusPacket.Message

Optional message or reason for state change.

Definition at line 41 of file AlgorithmStatusPacket.cs.

◆ AlgorithmId

string QuantConnect.Packets.AlgorithmStatusPacket.AlgorithmId

Algorithm Id associated with this status packet

Definition at line 46 of file AlgorithmStatusPacket.cs.

◆ OptimizationId

string QuantConnect.Packets.AlgorithmStatusPacket.OptimizationId

OptimizationId for this result packet if any

Definition at line 51 of file AlgorithmStatusPacket.cs.

◆ ProjectId

int QuantConnect.Packets.AlgorithmStatusPacket.ProjectId

Project Id associated with this status packet

Definition at line 56 of file AlgorithmStatusPacket.cs.

◆ ChannelStatus

string QuantConnect.Packets.AlgorithmStatusPacket.ChannelStatus

The current state of the channel

Definition at line 61 of file AlgorithmStatusPacket.cs.


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