Lean  $LEAN_TAG$
QuantConnect.Commands.UpdateOrderCommand Class Reference

Represents a command to update an order by id More...

Inheritance diagram for QuantConnect.Commands.UpdateOrderCommand:
[legend]

Public Member Functions

override CommandResultPacket Run (IAlgorithm algorithm)
 Runs this command against the specified algorithm instance More...
 

Properties

int OrderId [get, set]
 Gets or sets the id of the order to update More...
 
decimal? Quantity [get, set]
 Gets or sets the new quantity, specify null to not update the quantity More...
 
decimal? LimitPrice [get, set]
 Gets or sets the new limit price, specify null to not update the limit price. This will only be used if the order has a limit price (Limit/StopLimit orders) More...
 
decimal? StopPrice [get, set]
 Gets or sets the new stop price, specify null to not update the stop price. This will onky be used if the order has a stop price (StopLimit/StopMarket orders) More...
 
string Tag [get, set]
 Gets or sets the new tag for the order, specify null to not update the tag More...
 
- Properties inherited from QuantConnect.Commands.BaseCommand
string Id [get, set]
 Unique command id More...
 
- Properties inherited from QuantConnect.Commands.ICommand
string Id [get, set]
 Unique command id More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Commands.BaseCommand
Symbol GetSymbol (string ticker, SecurityType securityType, string market, Symbol symbol=null)
 Creats symbol using symbol properties. More...
 

Detailed Description

Represents a command to update an order by id

Definition at line 24 of file UpdateOrderCommand.cs.

Member Function Documentation

◆ Run()

override CommandResultPacket QuantConnect.Commands.UpdateOrderCommand.Run ( IAlgorithm  algorithm)
virtual

Runs this command against the specified algorithm instance

Parameters
algorithmThe algorithm to run this command against

Implements QuantConnect.Commands.BaseCommand.

Definition at line 57 of file UpdateOrderCommand.cs.

Property Documentation

◆ OrderId

int QuantConnect.Commands.UpdateOrderCommand.OrderId
getset

Gets or sets the id of the order to update

Definition at line 29 of file UpdateOrderCommand.cs.

◆ Quantity

decimal? QuantConnect.Commands.UpdateOrderCommand.Quantity
getset

Gets or sets the new quantity, specify null to not update the quantity

Definition at line 34 of file UpdateOrderCommand.cs.

◆ LimitPrice

decimal? QuantConnect.Commands.UpdateOrderCommand.LimitPrice
getset

Gets or sets the new limit price, specify null to not update the limit price. This will only be used if the order has a limit price (Limit/StopLimit orders)

Definition at line 40 of file UpdateOrderCommand.cs.

◆ StopPrice

decimal? QuantConnect.Commands.UpdateOrderCommand.StopPrice
getset

Gets or sets the new stop price, specify null to not update the stop price. This will onky be used if the order has a stop price (StopLimit/StopMarket orders)

Definition at line 46 of file UpdateOrderCommand.cs.

◆ Tag

string QuantConnect.Commands.UpdateOrderCommand.Tag
getset

Gets or sets the new tag for the order, specify null to not update the tag

Definition at line 51 of file UpdateOrderCommand.cs.


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