Provides a packet type for transmitting alpha insights data More...
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< Insight > | Insights [get, set] |
| The generated insights More... | |
| List< OrderEvent > | OrderEvents [get, set] |
| The generated OrderEvents More... | |
| List< Order > | Orders [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 69 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
-
algorithmId The algorithm's unique identifier userId The user's id insights Alphas generated by the algorithm orderEvents OrderEvents generated by the algorithm orders Orders generated or updated by the algorithm
Definition at line 82 of file AlphaResultPacket.cs.
Property Documentation
◆ UserId
|
getset |
The user's id that deployed the alpha stream
Definition at line 33 of file AlphaResultPacket.cs.
◆ 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 40 of file AlphaResultPacket.cs.
◆ AlgorithmId
|
getset |
The algorithm's unique identifier
Definition at line 46 of file AlphaResultPacket.cs.
◆ Insights
|
getset |
The generated insights
Definition at line 52 of file AlphaResultPacket.cs.
◆ OrderEvents
|
getset |
The generated OrderEvents
Definition at line 58 of file AlphaResultPacket.cs.
◆ Orders
|
getset |
The new or updated Orders
Definition at line 64 of file AlphaResultPacket.cs.
The documentation for this class was generated from the following file:
- Common/Packets/AlphaResultPacket.cs
