Lean  $LEAN_TAG$
QuantConnect.Commands.LiquidateCommand Class Reference

Represents a command that will liquidate the entire algorithm More...

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

Public Member Functions

override CommandResultPacket Run (IAlgorithm algorithm)
 Submits orders to liquidate all current holdings in the algorithm More...
 

Properties

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...
 
- 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 that will liquidate the entire algorithm

Definition at line 24 of file LiquidateCommand.cs.

Member Function Documentation

◆ Run()

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

Submits orders to liquidate all current holdings in the algorithm

Parameters
algorithmThe algorithm to be liquidated

Implements QuantConnect.Commands.BaseCommand.

Definition at line 45 of file LiquidateCommand.cs.

Here is the call graph for this function:

Property Documentation

◆ Ticker

string QuantConnect.Commands.LiquidateCommand.Ticker
getset

Gets or sets the string ticker symbol

Definition at line 29 of file LiquidateCommand.cs.

◆ SecurityType

SecurityType QuantConnect.Commands.LiquidateCommand.SecurityType
getset

Gets or sets the security type of the ticker.

Definition at line 34 of file LiquidateCommand.cs.

◆ Market

string QuantConnect.Commands.LiquidateCommand.Market
getset

Gets or sets the market the ticker resides in

Definition at line 39 of file LiquidateCommand.cs.


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