Lean  $LEAN_TAG$
QuantConnect.Packets.OrderEventPacket Class Reference

Order event packet for passing updates on the state of an order to the portfolio. More...

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

Public Member Functions

 OrderEventPacket ()
 Default constructor for JSON More...
 
 OrderEventPacket (string algorithmId, OrderEvent eventOrder)
 Create a new instance of the order event packet More...
 
- Public Member Functions inherited from QuantConnect.Packets.Packet
 Packet (PacketType type)
 Initialize the base class and setup the packet type. More...
 

Properties

OrderEvent Event [get, set]
 Order event object More...
 
string AlgorithmId [get, set]
 Algorithm id for this order event 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

Order event packet for passing updates on the state of an order to the portfolio.

As an order is updated in pieces/partial fills the order fill price is passed back to the Algorithm Portfolio method

Definition at line 25 of file OrderEventPacket.cs.

Constructor & Destructor Documentation

◆ OrderEventPacket() [1/2]

QuantConnect.Packets.OrderEventPacket.OrderEventPacket ( )

Default constructor for JSON

Definition at line 40 of file OrderEventPacket.cs.

◆ OrderEventPacket() [2/2]

QuantConnect.Packets.OrderEventPacket.OrderEventPacket ( string  algorithmId,
OrderEvent  eventOrder 
)

Create a new instance of the order event packet

Definition at line 47 of file OrderEventPacket.cs.

Property Documentation

◆ Event

OrderEvent QuantConnect.Packets.OrderEventPacket.Event
getset

Order event object

Definition at line 30 of file OrderEventPacket.cs.

◆ AlgorithmId

string QuantConnect.Packets.OrderEventPacket.AlgorithmId
getset

Algorithm id for this order event

Definition at line 35 of file OrderEventPacket.cs.


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