QuantConnect.Securities.BuyingPowerParameters Class Reference

Defines the parameters for IBuyingPowerModel.GetBuyingPower More...

Public Member Functions
	BuyingPowerParameters (SecurityPortfolioManager portfolio, Security security, OrderDirection direction)
	Initializes a new instance of the BuyingPowerParameters class More...
BuyingPower	Result (decimal buyingPower, string currency)
	Creates the result using the specified buying power More...
BuyingPower	ResultInAccountCurrency (decimal buyingPower)
	Creates the result using the specified buying power in units of the account currency More...

Properties
Security	Security [get]
	Gets the security More...
SecurityPortfolioManager	Portfolio [get]
	Gets the algorithm's portfolio More...
OrderDirection	Direction [get]
	Gets the direction in which buying power is to be computed More...

Detailed Description

Defines the parameters for IBuyingPowerModel.GetBuyingPower

Definition at line 23 of file BuyingPowerParameters.cs.

Constructor & Destructor Documentation

BuyingPowerParameters()

QuantConnect.Securities.BuyingPowerParameters.BuyingPowerParameters	(	SecurityPortfolioManager	portfolio,
		Security	security,
		OrderDirection	direction
	)

Initializes a new instance of the BuyingPowerParameters class

Parameters

portfolio	The algorithm's portfolio
security	The security
direction	The direction to compute buying power in

Definition at line 46 of file BuyingPowerParameters.cs.

Member Function Documentation

Result()

BuyingPower QuantConnect.Securities.BuyingPowerParameters.Result	(	decimal	buyingPower,
		string	currency
	)

Creates the result using the specified buying power

Parameters

buyingPower	The buying power
currency	The units the buying power is denominated in

Returns

The buying power

Definition at line 59 of file BuyingPowerParameters.cs.

Here is the caller graph for this function:

ResultInAccountCurrency()

BuyingPower QuantConnect.Securities.BuyingPowerParameters.ResultInAccountCurrency

(

decimal

buyingPower

)

Creates the result using the specified buying power in units of the account currency

Parameters

buyingPower

The buying power

Returns

The buying power

Definition at line 70 of file BuyingPowerParameters.cs.

Here is the caller graph for this function:

Property Documentation

Security

Security QuantConnect.Securities.BuyingPowerParameters.Security

get

Gets the security

Definition at line 28 of file BuyingPowerParameters.cs.

Portfolio

SecurityPortfolioManager QuantConnect.Securities.BuyingPowerParameters.Portfolio

get

Gets the algorithm's portfolio

Definition at line 33 of file BuyingPowerParameters.cs.

Direction

OrderDirection QuantConnect.Securities.BuyingPowerParameters.Direction

get

Gets the direction in which buying power is to be computed

Definition at line 38 of file BuyingPowerParameters.cs.

---

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

• Common/Securities/BuyingPowerParameters.cs