Lean  $LEAN_TAG$
Public Member Functions | Properties | List of all members
QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters Class Reference

Defines the parameters for IBuyingPowerModel.HasSufficientBuyingPowerForOrder More...

Public Member Functions

 HasSufficientBuyingPowerForOrderParameters (SecurityPortfolioManager portfolio, Security security, Order order)
 Initializes a new instance of the HasSufficientBuyingPowerForOrderParameters class More...
 
HasSufficientBuyingPowerForOrderParameters ForUnderlying (Order order)
 Creates a new HasSufficientBuyingPowerForOrderParameters targeting the security's underlying. If the security does not implement IDerivativeSecurity then an InvalidCastException will be thrown. If the order's symbol does not match the underlying then an ArgumentException will be thrown. More...
 
HasSufficientBuyingPowerForOrderResult Sufficient ()
 Creates a new result indicating that there is sufficient buying power for the contemplated order More...
 
HasSufficientBuyingPowerForOrderResult Insufficient (string reason)
 Creates a new result indicating that there is insufficient buying power for the contemplated order More...
 
HasSufficientBuyingPowerForOrderResult Insufficient (FormattableString reason)
 Creates a new result indicating that there is insufficient buying power for the contemplated order More...
 

Properties

SecurityPortfolioManager Portfolio [get]
 Gets the algorithm's portfolio More...
 
Security Security [get]
 Gets the security More...
 
Order Order [get]
 Gets the order More...
 

Detailed Description

Defines the parameters for IBuyingPowerModel.HasSufficientBuyingPowerForOrder

Definition at line 25 of file HasSufficientBuyingPowerForOrderParameters.cs.

Constructor & Destructor Documentation

◆ HasSufficientBuyingPowerForOrderParameters()

QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.HasSufficientBuyingPowerForOrderParameters ( SecurityPortfolioManager  portfolio,
Security  security,
Order  order 
)

Initializes a new instance of the HasSufficientBuyingPowerForOrderParameters class

Parameters
portfolioThe algorithm's portfolio
securityThe security
orderThe order

Definition at line 48 of file HasSufficientBuyingPowerForOrderParameters.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ ForUnderlying()

HasSufficientBuyingPowerForOrderParameters QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.ForUnderlying ( Order  order)

Creates a new HasSufficientBuyingPowerForOrderParameters targeting the security's underlying. If the security does not implement IDerivativeSecurity then an InvalidCastException will be thrown. If the order's symbol does not match the underlying then an ArgumentException will be thrown.

Parameters
orderThe new order targeting the underlying
Returns
New parameters instance suitable for invoking the sufficient capital method for the underlying security

Definition at line 63 of file HasSufficientBuyingPowerForOrderParameters.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Sufficient()

HasSufficientBuyingPowerForOrderResult QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.Sufficient ( )

Creates a new result indicating that there is sufficient buying power for the contemplated order

Definition at line 72 of file HasSufficientBuyingPowerForOrderParameters.cs.

Here is the caller graph for this function:

◆ Insufficient() [1/2]

HasSufficientBuyingPowerForOrderResult QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.Insufficient ( string  reason)

Creates a new result indicating that there is insufficient buying power for the contemplated order

Definition at line 80 of file HasSufficientBuyingPowerForOrderParameters.cs.

Here is the caller graph for this function:

◆ Insufficient() [2/2]

HasSufficientBuyingPowerForOrderResult QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.Insufficient ( FormattableString  reason)

Creates a new result indicating that there is insufficient buying power for the contemplated order

Definition at line 88 of file HasSufficientBuyingPowerForOrderParameters.cs.

Property Documentation

◆ Portfolio

SecurityPortfolioManager QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.Portfolio
get

Gets the algorithm's portfolio

Definition at line 30 of file HasSufficientBuyingPowerForOrderParameters.cs.

◆ Security

Security QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.Security
get

Gets the security

Definition at line 35 of file HasSufficientBuyingPowerForOrderParameters.cs.

◆ Order

Order QuantConnect.Securities.HasSufficientBuyingPowerForOrderParameters.Order
get

Gets the order

Definition at line 40 of file HasSufficientBuyingPowerForOrderParameters.cs.

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