QuantConnect.Commands.BaseCommand Class Referenceabstract
Base command implementation More...
Inheritance diagram for QuantConnect.Commands.BaseCommand:
Public Member Functions | |
| abstract CommandResultPacket | Run (IAlgorithm algorithm) |
| Runs this command against the specified algorithm instance More... | |
Protected Member Functions | |
| Symbol | GetSymbol (string ticker, SecurityType securityType, string market, Symbol symbol=null) |
| Creats symbol using symbol properties. More... | |
Properties | |
| string | Id [get, set] |
| Unique command id More... | |
 Properties inherited from QuantConnect.Commands.ICommand | |
| string | Id [get, set] |
| Unique command id More... | |
Detailed Description
Base command implementation
Definition at line 24 of file BaseCommand.cs.
Member Function Documentation
◆ Run()
|
pure virtual |
Runs this command against the specified algorithm instance
- Parameters
-
algorithm The algorithm to run this command against
Implements QuantConnect.Commands.ICommand.
Implemented in QuantConnect.Commands.AddSecurityCommand, QuantConnect.Commands.OrderCommand, QuantConnect.Commands.UpdateOrderCommand, QuantConnect.Commands.AlgorithmStatusCommand, QuantConnect.Commands.LiquidateCommand, and QuantConnect.Commands.CancelOrderCommand.
◆ GetSymbol()
|
protected |
Creats symbol using symbol properties.
- Parameters
-
ticker The string ticker symbol securityType The security type of the ticker. If securityType == Option, then a canonical symbol is created market The market the ticker resides in symbol The algorithm to run this command against
- Exceptions
-
ArgumentException If symbol is null or symbol can't be created with given args
Definition at line 45 of file BaseCommand.cs.
Here is the call graph for this function:
Here is the caller graph for this function:
Property Documentation
◆ Id
|
getset |
Unique command id
Definition at line 29 of file BaseCommand.cs.
The documentation for this class was generated from the following file:
- Common/Commands/BaseCommand.cs
