Lean  $LEAN_TAG$
QuantConnect.Commands.OrderCommand Class Reference

Represents a command to submit an order to the algorithm More...

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

Public Member Functions

override CommandResultPacket Run (IAlgorithm algorithm)
 Runs this command against the specified algorithm instance More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Properties

Symbol Symbol [get, set]
 Gets or sets the symbol to be ordered More...
 
string Ticker [get, set]
 Gets or sets the string ticker symbol More...
 
SecurityType SecurityType [get, set]
 Gets or sets the security type of the ticker. More...
 
string Market [get, set]
 Gets or sets the market the ticker resides in More...
 
OrderType OrderType [get, set]
 Gets or sets the order type to be submted More...
 
decimal Quantity [get, set]
 Gets or sets the number of units to be ordered (directional) More...
 
decimal LimitPrice [get, set]
 Gets or sets the limit price. Only applies to QuantConnect.Orders.OrderType.Limit and QuantConnect.Orders.OrderType.StopLimit More...
 
decimal StopPrice [get, set]
 Gets or sets the stop price. Only applies to QuantConnect.Orders.OrderType.StopLimit and QuantConnect.Orders.OrderType.StopMarket More...
 
string Tag [get, set]
 Gets or sets an arbitrary tag to be attached to the order 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 submit an order to the algorithm

Definition at line 25 of file OrderCommand.cs.

Member Function Documentation

◆ Run()

override CommandResultPacket QuantConnect.Commands.OrderCommand.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 76 of file OrderCommand.cs.

Here is the call graph for this function:

◆ ToString()

override string QuantConnect.Commands.OrderCommand.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 103 of file OrderCommand.cs.

Here is the call graph for this function:

Property Documentation

◆ Symbol

Symbol QuantConnect.Commands.OrderCommand.Symbol
getset

Gets or sets the symbol to be ordered

Definition at line 30 of file OrderCommand.cs.

◆ Ticker

string QuantConnect.Commands.OrderCommand.Ticker
getset

Gets or sets the string ticker symbol

Definition at line 35 of file OrderCommand.cs.

◆ SecurityType

SecurityType QuantConnect.Commands.OrderCommand.SecurityType
getset

Gets or sets the security type of the ticker.

Definition at line 40 of file OrderCommand.cs.

◆ Market

string QuantConnect.Commands.OrderCommand.Market
getset

Gets or sets the market the ticker resides in

Definition at line 45 of file OrderCommand.cs.

◆ OrderType

OrderType QuantConnect.Commands.OrderCommand.OrderType
getset

Gets or sets the order type to be submted

Definition at line 50 of file OrderCommand.cs.

◆ Quantity

decimal QuantConnect.Commands.OrderCommand.Quantity
getset

Gets or sets the number of units to be ordered (directional)

Definition at line 55 of file OrderCommand.cs.

◆ LimitPrice

decimal QuantConnect.Commands.OrderCommand.LimitPrice
getset

Gets or sets the limit price. Only applies to QuantConnect.Orders.OrderType.Limit and QuantConnect.Orders.OrderType.StopLimit

Definition at line 60 of file OrderCommand.cs.

◆ StopPrice

decimal QuantConnect.Commands.OrderCommand.StopPrice
getset

Gets or sets the stop price. Only applies to QuantConnect.Orders.OrderType.StopLimit and QuantConnect.Orders.OrderType.StopMarket

Definition at line 65 of file OrderCommand.cs.

◆ Tag

string QuantConnect.Commands.OrderCommand.Tag
getset

Gets or sets an arbitrary tag to be attached to the order

Definition at line 70 of file OrderCommand.cs.


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