Lean  $LEAN_TAG$
QuantConnect.Securities.MaintenanceMarginParameters Class Reference

Parameters for IBuyingPowerModel.GetMaintenanceMargin More...

Public Member Functions

 MaintenanceMarginParameters (Security security, decimal quantity, decimal holdingsCost, decimal holdingsValue)
 Initializes a new instance of the MaintenanceMarginParameters class More...
 
MaintenanceMarginParameters ForUnderlying (decimal quantity)
 Creates a new instance of MaintenanceMarginParameters for the security's underlying More...
 

Static Public Member Functions

static MaintenanceMarginParameters ForCurrentHoldings (Security security)
 Creates a new instance of the MaintenanceMarginParameters class to compute the maintenance margin required to support the algorithm's current holdings More...
 
static MaintenanceMarginParameters ForQuantityAtCurrentPrice (Security security, decimal quantity)
 Creates a new instance of the MaintenanceMarginParameters class to compute the maintenance margin required to support the specified quantity of holdings at current market prices More...
 

Public Attributes

decimal AbsoluteQuantity => Math.Abs(Quantity)
 Gets the absolute quantity of the security More...
 
decimal AbsoluteHoldingsCost => Math.Abs(HoldingsCost)
 Gets the absolute holdings cost of the security More...
 
decimal AbsoluteHoldingsValue => Math.Abs(HoldingsValue)
 Gets the absolute holdings value of the security More...
 

Properties

Security Security [get]
 Gets the security More...
 
decimal Quantity [get]
 Gets the quantity of the security More...
 
decimal HoldingsCost [get]
 Gets the holdings cost of the security More...
 
decimal HoldingsValue [get]
 Gets the holdings value of the security More...
 

Detailed Description

Constructor & Destructor Documentation

◆ MaintenanceMarginParameters()

QuantConnect.Securities.MaintenanceMarginParameters.MaintenanceMarginParameters ( Security  security,
decimal  quantity,
decimal  holdingsCost,
decimal  holdingsValue 
)

Initializes a new instance of the MaintenanceMarginParameters class

Parameters
securityThe security
quantityThe quantity
holdingsCostThe holdings cost
holdingsValueThe holdings value

Definition at line 67 of file MaintenanceMarginParameters.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ ForCurrentHoldings()

static MaintenanceMarginParameters QuantConnect.Securities.MaintenanceMarginParameters.ForCurrentHoldings ( Security  security)
static

Creates a new instance of the MaintenanceMarginParameters class to compute the maintenance margin required to support the algorithm's current holdings

Definition at line 84 of file MaintenanceMarginParameters.cs.

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

◆ ForQuantityAtCurrentPrice()

static MaintenanceMarginParameters QuantConnect.Securities.MaintenanceMarginParameters.ForQuantityAtCurrentPrice ( Security  security,
decimal  quantity 
)
static

Creates a new instance of the MaintenanceMarginParameters class to compute the maintenance margin required to support the specified quantity of holdings at current market prices

Definition at line 97 of file MaintenanceMarginParameters.cs.

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

◆ ForUnderlying()

MaintenanceMarginParameters QuantConnect.Securities.MaintenanceMarginParameters.ForUnderlying ( decimal  quantity)

Creates a new instance of MaintenanceMarginParameters for the security's underlying

Definition at line 106 of file MaintenanceMarginParameters.cs.

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

Member Data Documentation

◆ AbsoluteQuantity

decimal QuantConnect.Securities.MaintenanceMarginParameters.AbsoluteQuantity => Math.Abs(Quantity)

Gets the absolute quantity of the security

Definition at line 38 of file MaintenanceMarginParameters.cs.

◆ AbsoluteHoldingsCost

decimal QuantConnect.Securities.MaintenanceMarginParameters.AbsoluteHoldingsCost => Math.Abs(HoldingsCost)

Gets the absolute holdings cost of the security

Definition at line 48 of file MaintenanceMarginParameters.cs.

◆ AbsoluteHoldingsValue

decimal QuantConnect.Securities.MaintenanceMarginParameters.AbsoluteHoldingsValue => Math.Abs(HoldingsValue)

Gets the absolute holdings value of the security

Definition at line 58 of file MaintenanceMarginParameters.cs.

Property Documentation

◆ Security

Security QuantConnect.Securities.MaintenanceMarginParameters.Security
get

Gets the security

Definition at line 28 of file MaintenanceMarginParameters.cs.

◆ Quantity

decimal QuantConnect.Securities.MaintenanceMarginParameters.Quantity
get

Gets the quantity of the security

Definition at line 33 of file MaintenanceMarginParameters.cs.

◆ HoldingsCost

decimal QuantConnect.Securities.MaintenanceMarginParameters.HoldingsCost
get

Gets the holdings cost of the security

Definition at line 43 of file MaintenanceMarginParameters.cs.

◆ HoldingsValue

decimal QuantConnect.Securities.MaintenanceMarginParameters.HoldingsValue
get

Gets the holdings value of the security

Definition at line 53 of file MaintenanceMarginParameters.cs.


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