Lean  $LEAN_TAG$
LogPacket.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 using Newtonsoft.Json;
18 
19 namespace QuantConnect.Packets
20 {
21  /// <summary>
22  /// Simple log message instruction from the lean engine.
23  /// </summary>
24  public class LogPacket : Packet
25  {
26  /// <summary>
27  /// Log message to the users console:
28  /// </summary>
29  public string Message { get; set; }
30 
31  /// <summary>
32  /// Algorithm Id requesting this logging
33  /// </summary>
34  public string AlgorithmId { get; set; }
35 
36  /// <summary>
37  /// Default constructor for JSON
38  /// </summary>
39  public LogPacket()
40  : base (PacketType.Log)
41  { }
42 
43  /// <summary>
44  /// Create a new instance of the notify Log packet:
45  /// </summary>
46  public LogPacket(string algorithmId, string message)
47  : base(PacketType.Log)
48  {
49  Message = message;
50  AlgorithmId = algorithmId;
51  }
52 
53  } // End Work Packet:
54 
55 } // End of Namespace: