QuantConnect.Commands.AlgorithmStatusCommand Class Reference
Represents a command that will change the algorithm's status More...
Inheritance diagram for QuantConnect.Commands.AlgorithmStatusCommand:
Public Member Functions | |
| AlgorithmStatusCommand () | |
| Initializes a new instance of the AlgorithmStatusCommand More... | |
| AlgorithmStatusCommand (AlgorithmStatus status) | |
| Initializes a new instance of the AlgorithmStatusCommand with the specified status More... | |
| override CommandResultPacket | Run (IAlgorithm algorithm) |
| Sets the algorithm's status to Status More... | |
Properties | |
| AlgorithmStatus | Status [get, set] |
| Gets or sets the algorithm status 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 change the algorithm's status
Definition at line 23 of file AlgorithmStatusCommand.cs.
Constructor & Destructor Documentation
◆ AlgorithmStatusCommand() [1/2]
| QuantConnect.Commands.AlgorithmStatusCommand.AlgorithmStatusCommand | ( | ) |
Initializes a new instance of the AlgorithmStatusCommand
Definition at line 33 of file AlgorithmStatusCommand.cs.
◆ AlgorithmStatusCommand() [2/2]
| QuantConnect.Commands.AlgorithmStatusCommand.AlgorithmStatusCommand | ( | AlgorithmStatus | status | ) |
Initializes a new instance of the AlgorithmStatusCommand with the specified status
Definition at line 42 of file AlgorithmStatusCommand.cs.
Member Function Documentation
◆ Run()
|
virtual |
Sets the algorithm's status to Status
- Parameters
-
algorithm The algorithm to run this command against
Implements QuantConnect.Commands.BaseCommand.
Definition at line 51 of file AlgorithmStatusCommand.cs.
Property Documentation
◆ Status
|
getset |
Gets or sets the algorithm status
Definition at line 28 of file AlgorithmStatusCommand.cs.
The documentation for this class was generated from the following file:
- Common/Commands/AlgorithmStatusCommand.cs
