Lean  $LEAN_TAG$
HandledErrorPacket.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  *
15 */
16 
17 namespace QuantConnect.Packets
18 {
19  /// <summary>
20  /// Algorithm runtime error packet from the lean engine.
21  /// This is a managed error which stops the algorithm execution.
22  /// </summary>
23  public class HandledErrorPacket : Packet
24  {
25  /// <summary>
26  /// Runtime error message from the exception
27  /// </summary>
28  public string Message { get; set; }
29 
30  /// <summary>
31  /// Algorithm id which generated this runtime error
32  /// </summary>
33  public string AlgorithmId { get; set; }
34 
35  /// <summary>
36  /// Error stack trace information string passed through from the Lean exception
37  /// </summary>
38  public string StackTrace { get; set; }
39 
40  /// <summary>
41  /// Default constructor for JSON
42  /// </summary>
43  public HandledErrorPacket()
44  : base (PacketType.HandledError)
45  { }
46 
47  /// <summary>
48  /// Create a new handled error packet
49  /// </summary>
50  public HandledErrorPacket(string algorithmId, string message, string stacktrace = "")
51  : base(PacketType.HandledError)
52  {
53  Message = message;
54  AlgorithmId = algorithmId;
55  StackTrace = stacktrace;
56  }
57 
58  } // End Work Packet:
59 
60 } // End of Namespace: