Lean  $LEAN_TAG$
QuantConnect.Securities.Positions.IPositionGroup Interface Reference

Defines a group of positions allowing for more efficient use of portfolio margin More...

Inheritance diagram for QuantConnect.Securities.Positions.IPositionGroup:
[legend]

Public Member Functions

bool TryGetPosition (Symbol symbol, out IPosition position)
 Attempts to retrieve the position with the specified symbol More...
 

Properties

PositionGroupKey Key [get]
 Gets the key identifying this group More...
 
decimal Quantity [get]
 Gets the whole number of units in this position group More...
 
IEnumerable< IPositionPositions [get]
 Gets the positions in this group More...
 
IPositionGroupBuyingPowerModel BuyingPowerModel [get]
 Gets the buying power model defining how margin works in this group More...
 

Detailed Description

Defines a group of positions allowing for more efficient use of portfolio margin

Definition at line 23 of file IPositionGroup.cs.

Member Function Documentation

◆ TryGetPosition()

bool QuantConnect.Securities.Positions.IPositionGroup.TryGetPosition ( Symbol  symbol,
out IPosition  position 
)

Attempts to retrieve the position with the specified symbol

Parameters
symbolThe symbol
positionThe position, if found
Returns
True if the position was found, otherwise false

Implemented in QuantConnect.Securities.Positions.PositionGroup.

Here is the caller graph for this function:

Property Documentation

◆ Key

PositionGroupKey QuantConnect.Securities.Positions.IPositionGroup.Key
get

Gets the key identifying this group

Definition at line 28 of file IPositionGroup.cs.

◆ Quantity

decimal QuantConnect.Securities.Positions.IPositionGroup.Quantity
get

Gets the whole number of units in this position group

Definition at line 33 of file IPositionGroup.cs.

◆ Positions

IEnumerable<IPosition> QuantConnect.Securities.Positions.IPositionGroup.Positions
get

Gets the positions in this group

Definition at line 38 of file IPositionGroup.cs.

◆ BuyingPowerModel

IPositionGroupBuyingPowerModel QuantConnect.Securities.Positions.IPositionGroup.BuyingPowerModel
get

Gets the buying power model defining how margin works in this group

Definition at line 43 of file IPositionGroup.cs.


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