Lean  $LEAN_TAG$
QuantConnect.Packets.AlphaResultPacket Class Reference

Provides a packet type for transmitting alpha insights data More...

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

Public Member Functions

 AlphaResultPacket ()
 Initializes a new instance of the AlphaResultPacket class More...
 
 AlphaResultPacket (string algorithmId, int userId, List< Insight > insights=null, List< OrderEvent > orderEvents=null, List< Order > orders=null)
 Initializes a new instance of the AlphaResultPacket class More...
 
- Public Member Functions inherited from QuantConnect.Packets.Packet
 Packet (PacketType type)
 Initialize the base class and setup the packet type. More...
 

Properties

int UserId [get, set]
 The user's id that deployed the alpha stream More...
 
string AlphaId [get, set]
 The deployed alpha id. This is the id generated upon submssion to the alpha marketplace. If this is a user backtest or live algo then this will not be specified More...
 
string AlgorithmId [get, set]
 The algorithm's unique identifier More...
 
List< InsightInsights [get, set]
 The generated insights More...
 
List< OrderEventOrderEvents [get, set]
 The generated OrderEvents More...
 
List< OrderOrders [get, set]
 The new or updated Orders 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

Provides a packet type for transmitting alpha insights data

Definition at line 27 of file AlphaResultPacket.cs.

Constructor & Destructor Documentation

◆ AlphaResultPacket() [1/2]

QuantConnect.Packets.AlphaResultPacket.AlphaResultPacket ( )

Initializes a new instance of the AlphaResultPacket class

Definition at line 67 of file AlphaResultPacket.cs.

◆ AlphaResultPacket() [2/2]

QuantConnect.Packets.AlphaResultPacket.AlphaResultPacket ( string  algorithmId,
int  userId,
List< Insight insights = null,
List< OrderEvent orderEvents = null,
List< Order orders = null 
)

Initializes a new instance of the AlphaResultPacket class

Parameters
algorithmIdThe algorithm's unique identifier
userIdThe user's id
insightsAlphas generated by the algorithm
orderEventsOrderEvents generated by the algorithm
ordersOrders generated or updated by the algorithm

Definition at line 80 of file AlphaResultPacket.cs.

Property Documentation

◆ UserId

int QuantConnect.Packets.AlphaResultPacket.UserId
getset

The user's id that deployed the alpha stream

Definition at line 32 of file AlphaResultPacket.cs.

◆ AlphaId

string QuantConnect.Packets.AlphaResultPacket.AlphaId
getset

The deployed alpha id. This is the id generated upon submssion to the alpha marketplace. If this is a user backtest or live algo then this will not be specified

Definition at line 39 of file AlphaResultPacket.cs.

◆ AlgorithmId

string QuantConnect.Packets.AlphaResultPacket.AlgorithmId
getset

The algorithm's unique identifier

Definition at line 44 of file AlphaResultPacket.cs.

◆ Insights

List<Insight> QuantConnect.Packets.AlphaResultPacket.Insights
getset

The generated insights

Definition at line 50 of file AlphaResultPacket.cs.

◆ OrderEvents

List<OrderEvent> QuantConnect.Packets.AlphaResultPacket.OrderEvents
getset

The generated OrderEvents

Definition at line 56 of file AlphaResultPacket.cs.

◆ Orders

List<Order> QuantConnect.Packets.AlphaResultPacket.Orders
getset

The new or updated Orders

Definition at line 62 of file AlphaResultPacket.cs.


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