Lean  $LEAN_TAG$
QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters Class Reference

Defines the parameters for IPositionGroupBuyingPowerModel.HasSufficientBuyingPowerForOrder More...

Public Member Functions

 HasSufficientPositionGroupBuyingPowerForOrderParameters (SecurityPortfolioManager portfolio, IPositionGroup positionGroup, List< Order > orders)
 Initializes a new instance of the HasSufficientPositionGroupBuyingPowerForOrderParameters class 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 Error (string reason)
 Creates a new result indicating that there was an error More...
 

Static Public Member Functions

static implicit operator HasSufficientBuyingPowerForOrderParameters (HasSufficientPositionGroupBuyingPowerForOrderParameters parameters)
 This may be called for non-combo type orders where the position group is guaranteed to have exactly one position More...
 

Properties

List< OrderOrders [get]
 The orders associated with this request More...
 
IPositionGroup PositionGroup [get]
 Gets the position group representing the holdings changes contemplated by the order More...
 
SecurityPortfolioManager Portfolio [get]
 Gets the algorithm's portfolio manager More...
 

Detailed Description

Constructor & Destructor Documentation

◆ HasSufficientPositionGroupBuyingPowerForOrderParameters()

QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.HasSufficientPositionGroupBuyingPowerForOrderParameters ( SecurityPortfolioManager  portfolio,
IPositionGroup  positionGroup,
List< Order orders 
)

Initializes a new instance of the HasSufficientPositionGroupBuyingPowerForOrderParameters class

Parameters
portfolioThe algorithm's portfolio manager
positionGroupThe position group
ordersThe orders

Definition at line 48 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

Member Function Documentation

◆ operator HasSufficientBuyingPowerForOrderParameters()

static implicit QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.operator HasSufficientBuyingPowerForOrderParameters ( HasSufficientPositionGroupBuyingPowerForOrderParameters  parameters)
static

This may be called for non-combo type orders where the position group is guaranteed to have exactly one position

Definition at line 62 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

◆ Sufficient()

HasSufficientBuyingPowerForOrderResult QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.Sufficient ( )

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

Definition at line 74 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

Here is the caller graph for this function:

◆ Insufficient()

HasSufficientBuyingPowerForOrderResult QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.Insufficient ( string  reason)

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

Definition at line 82 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

Here is the caller graph for this function:

◆ Error()

HasSufficientBuyingPowerForOrderResult QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.Error ( string  reason)

Creates a new result indicating that there was an error

Definition at line 90 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

Here is the caller graph for this function:

Property Documentation

◆ Orders

List<Order> QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.Orders
get

The orders associated with this request

Definition at line 30 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

◆ PositionGroup

IPositionGroup QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.PositionGroup
get

Gets the position group representing the holdings changes contemplated by the order

Definition at line 35 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.

◆ Portfolio

SecurityPortfolioManager QuantConnect.Securities.Positions.HasSufficientPositionGroupBuyingPowerForOrderParameters.Portfolio
get

Gets the algorithm's portfolio manager

Definition at line 40 of file HasSufficientPositionGroupBuyingPowerForOrderParameters.cs.


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