Lean  $LEAN_TAG$
OrderEventPacket.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 QuantConnect.Orders;
18 
19 namespace QuantConnect.Packets
20 {
21  /// <summary>
22  /// Order event packet for passing updates on the state of an order to the portfolio.
23  /// </summary>
24  /// <remarks>As an order is updated in pieces/partial fills the order fill price is passed back to the Algorithm Portfolio method</remarks>
25  public class OrderEventPacket : Packet
26  {
27  /// <summary>
28  /// Order event object
29  /// </summary>
30  public OrderEvent Event { get; set; }
31 
32  /// <summary>
33  /// Algorithm id for this order event
34  /// </summary>
35  public string AlgorithmId { get; set; }
36 
37  /// <summary>
38  /// Default constructor for JSON
39  /// </summary>
40  public OrderEventPacket()
41  : base (PacketType.OrderEvent)
42  { }
43 
44  /// <summary>
45  /// Create a new instance of the order event packet
46  /// </summary>
47  public OrderEventPacket(string algorithmId, OrderEvent eventOrder)
48  : base(PacketType.OrderEvent)
49  {
50  AlgorithmId = algorithmId;
51  Event = eventOrder;
52  }
53 
54  } // End Order Event Packet:
55 
56 } // End of Namespace: