Lean  $LEAN_TAG$
QuantConnect.Securities.MarginCallOrdersParameters Class Reference

Defines the parameters for DefaultMarginCallModel.GenerateMarginCallOrders More...

Public Member Functions

 MarginCallOrdersParameters (IPositionGroup positionGroup, decimal totalPortfolioValue, decimal totalUsedMargin)
 Initializes a new instance of the MarginCallOrdersParameters class More...
 

Properties

IPositionGroup PositionGroup [get]
 Gets the position group More...
 
decimal TotalPortfolioValue [get]
 Gets the algorithm's total portfolio value More...
 
decimal TotalUsedMargin [get]
 Gets the total used margin More...
 

Detailed Description

Defines the parameters for DefaultMarginCallModel.GenerateMarginCallOrders

Definition at line 23 of file MarginCallOrdersParameters.cs.

Constructor & Destructor Documentation

◆ MarginCallOrdersParameters()

QuantConnect.Securities.MarginCallOrdersParameters.MarginCallOrdersParameters ( IPositionGroup  positionGroup,
decimal  totalPortfolioValue,
decimal  totalUsedMargin 
)

Initializes a new instance of the MarginCallOrdersParameters class

Parameters
positionGroupThe position group
totalPortfolioValueThe algorithm's total portfolio value
totalUsedMarginThe total used margin

Definition at line 46 of file MarginCallOrdersParameters.cs.

Property Documentation

◆ PositionGroup

IPositionGroup QuantConnect.Securities.MarginCallOrdersParameters.PositionGroup
get

Gets the position group

Definition at line 28 of file MarginCallOrdersParameters.cs.

◆ TotalPortfolioValue

decimal QuantConnect.Securities.MarginCallOrdersParameters.TotalPortfolioValue
get

Gets the algorithm's total portfolio value

Definition at line 33 of file MarginCallOrdersParameters.cs.

◆ TotalUsedMargin

decimal QuantConnect.Securities.MarginCallOrdersParameters.TotalUsedMargin
get

Gets the total used margin

Definition at line 38 of file MarginCallOrdersParameters.cs.


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