Provides an implementation of IPortfolioTarget that specifies a specified quantity of a security to be held by the algorithm
More...
|
static ? bool | MinimumOrderMarginPercentageWarningSent [get, set] |
| Flag to determine if the minimum order margin portfolio percentage warning should or has already been sent to the user algorithm IAlgorithmSettings.MinimumOrderMarginPortfolioPercentage More...
|
|
Symbol | Symbol [get] |
| Gets the symbol of this target More...
|
|
decimal | Quantity [get] |
| Gets the target quantity for the symbol More...
|
|
string | Tag [get] |
| Portfolio target tag with additional information More...
|
|
Symbol | Symbol [get] |
| Gets the symbol of this target More...
|
|
decimal | Quantity [get] |
| Gets the quantity of this symbol the algorithm should hold More...
|
|
string | Tag [get] |
| Portfolio target tag with additional information More...
|
|
Provides an implementation of IPortfolioTarget that specifies a specified quantity of a security to be held by the algorithm
Definition at line 28 of file PortfolioTarget.cs.
◆ PortfolioTarget()
QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.PortfolioTarget |
( |
Symbol |
symbol, |
|
|
decimal |
quantity, |
|
|
string |
tag = "" |
|
) |
| |
Initializes a new instance of the PortfolioTarget class
- Parameters
-
symbol | The symbol this target is for |
quantity | The target quantity |
tag | The target tag with additional information |
Definition at line 58 of file PortfolioTarget.cs.
◆ Percent() [1/3]
Creates a new target for the specified percent
- Parameters
-
algorithm | The algorithm instance, used for getting total portfolio value and current security price |
symbol | The symbol the target is for |
percent | The requested target percent of total portfolio value |
- Returns
- A portfolio target for the specified symbol/percent
Definition at line 72 of file PortfolioTarget.cs.
◆ Percent() [2/3]
Creates a new target for the specified percent
- Parameters
-
algorithm | The algorithm instance, used for getting total portfolio value and current security price |
symbol | The symbol the target is for |
percent | The requested target percent of total portfolio value |
tag | The target tag with additional information |
- Returns
- A portfolio target for the specified symbol/percent
Definition at line 85 of file PortfolioTarget.cs.
◆ Percent() [3/3]
static IPortfolioTarget QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.Percent |
( |
IAlgorithm |
algorithm, |
|
|
Symbol |
symbol, |
|
|
decimal |
percent, |
|
|
bool |
returnDeltaQuantity = false , |
|
|
string |
tag = "" |
|
) |
| |
|
static |
Creates a new target for the specified percent
- Parameters
-
algorithm | The algorithm instance, used for getting total portfolio value and current security price |
symbol | The symbol the target is for |
percent | The requested target percent of total portfolio value |
returnDeltaQuantity | True, result quantity will be the Delta required to reach target percent. False, the result quantity will be the Total quantity to reach the target percent, including current holdings |
tag | The target tag with additional information |
- Returns
- A portfolio target for the specified symbol/percent
Definition at line 100 of file PortfolioTarget.cs.
◆ ToString()
override string QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.ToString |
( |
| ) |
|
Returns a string that represents the current object.
- Returns
- A string that represents the current object.
<filterpriority>2</filterpriority>
Definition at line 163 of file PortfolioTarget.cs.
◆ MinimumOrderMarginPercentageWarningSent
? bool QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.MinimumOrderMarginPercentageWarningSent |
|
staticgetset |
Flag to determine if the minimum order margin portfolio percentage warning should or has already been sent to the user algorithm IAlgorithmSettings.MinimumOrderMarginPortfolioPercentage
Definition at line 35 of file PortfolioTarget.cs.
◆ Symbol
Symbol QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.Symbol |
|
get |
◆ Quantity
decimal QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.Quantity |
|
get |
◆ Tag
string QuantConnect.Algorithm.Framework.Portfolio.PortfolioTarget.Tag |
|
get |
The documentation for this class was generated from the following file: