Lean  $LEAN_TAG$
QuantConnect.Packets.HandledErrorPacket Class Reference

Algorithm runtime error packet from the lean engine. This is a managed error which stops the algorithm execution. More...

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

Public Member Functions

 HandledErrorPacket ()
 Default constructor for JSON More...
 
 HandledErrorPacket (string algorithmId, string message, string stacktrace="")
 Create a new handled error 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 Message [get, set]
 Runtime error message from the exception More...
 
string AlgorithmId [get, set]
 Algorithm id which generated this runtime error More...
 
string StackTrace [get, set]
 Error stack trace information string passed through from the Lean exception 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...
 

Detailed Description

Algorithm runtime error packet from the lean engine. This is a managed error which stops the algorithm execution.

Definition at line 23 of file HandledErrorPacket.cs.

Constructor & Destructor Documentation

◆ HandledErrorPacket() [1/2]

QuantConnect.Packets.HandledErrorPacket.HandledErrorPacket ( )

Default constructor for JSON

Definition at line 43 of file HandledErrorPacket.cs.

◆ HandledErrorPacket() [2/2]

QuantConnect.Packets.HandledErrorPacket.HandledErrorPacket ( string  algorithmId,
string  message,
string  stacktrace = "" 
)

Create a new handled error packet

Definition at line 50 of file HandledErrorPacket.cs.

Property Documentation

◆ Message

string QuantConnect.Packets.HandledErrorPacket.Message
getset

Runtime error message from the exception

Definition at line 28 of file HandledErrorPacket.cs.

◆ AlgorithmId

string QuantConnect.Packets.HandledErrorPacket.AlgorithmId
getset

Algorithm id which generated this runtime error

Definition at line 33 of file HandledErrorPacket.cs.

◆ StackTrace

string QuantConnect.Packets.HandledErrorPacket.StackTrace
getset

Error stack trace information string passed through from the Lean exception

Definition at line 38 of file HandledErrorPacket.cs.


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