Specifies the impact on buying power from changing security holdings that affects current IPositionGroup, including the current reserved buying power, without the change, and a contemplate reserved buying power, which takes into account a contemplated change to the algorithm's positions that impacts current position groups. More...

Public Member Functions
	ReservedBuyingPowerImpact (decimal current, decimal contemplated, IReadOnlyCollection< IPositionGroup > impactedGroups, IReadOnlyCollection< IPosition > contemplatedChanges, IReadOnlyCollection< IPositionGroup > contemplatedGroups)
	Initializes a new instance of the ReservedBuyingPowerImpact class More...

Properties
decimal	Current `[get]`
	Gets the current reserved buying power for the impacted groups More...

decimal	Contemplated `[get]`
	Gets the reserved buying power for groups resolved after applying a contemplated change to the impacted groups More...

decimal	Delta `[get]`
	Gets the change in reserved buying power, Current minus Contemplated More...

IReadOnlyCollection< IPositionGroup >	ImpactedGroups `[get]`
	Gets the impacted groups used as the basis for these reserved buying power numbers More...

IReadOnlyCollection< IPosition >	ContemplatedChanges `[get]`
	Gets the position changes being contemplated More...

IReadOnlyCollection< IPositionGroup >	ContemplatedGroups `[get]`
	Gets the newly resolved groups resulting from applying the contemplated changes to the impacted groups More...

Detailed Description

Specifies the impact on buying power from changing security holdings that affects current IPositionGroup, including the current reserved buying power, without the change, and a contemplate reserved buying power, which takes into account a contemplated change to the algorithm's positions that impacts current position groups.

Definition at line 25 of file ReservedBuyingPowerImpact.cs.

Constructor & Destructor Documentation

◆ ReservedBuyingPowerImpact()

QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.ReservedBuyingPowerImpact	(	decimal	current,
		decimal	contemplated,
		IReadOnlyCollection< IPositionGroup >	impactedGroups,
		IReadOnlyCollection< IPosition >	contemplatedChanges,
		IReadOnlyCollection< IPositionGroup >	contemplatedGroups
	)

Initializes a new instance of the ReservedBuyingPowerImpact class

Parameters

current	The current reserved buying power for impacted groups
contemplated	The reserved buying power for impacted groups after applying the contemplated changes
impactedGroups	The groups impacted by the contemplated changes
contemplatedChanges	The position changes being contemplated
contemplatedGroups	The groups resulting from applying the contemplated changes

Definition at line 65 of file ReservedBuyingPowerImpact.cs.

Property Documentation

◆ Current

decimal QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.Current

get

Gets the current reserved buying power for the impacted groups

Definition at line 30 of file ReservedBuyingPowerImpact.cs.

◆ Contemplated

decimal QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.Contemplated

get

Gets the reserved buying power for groups resolved after applying a contemplated change to the impacted groups

Definition at line 35 of file ReservedBuyingPowerImpact.cs.

◆ Delta

decimal QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.Delta

get

Gets the change in reserved buying power, Current minus Contemplated

Definition at line 40 of file ReservedBuyingPowerImpact.cs.

◆ ImpactedGroups

IReadOnlyCollection<IPositionGroup> QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.ImpactedGroups

get

Gets the impacted groups used as the basis for these reserved buying power numbers

Definition at line 45 of file ReservedBuyingPowerImpact.cs.

◆ ContemplatedChanges

IReadOnlyCollection<IPosition> QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.ContemplatedChanges

get

Gets the position changes being contemplated

Definition at line 50 of file ReservedBuyingPowerImpact.cs.

◆ ContemplatedGroups

IReadOnlyCollection<IPositionGroup> QuantConnect.Securities.Positions.ReservedBuyingPowerImpact.ContemplatedGroups

get

Gets the newly resolved groups resulting from applying the contemplated changes to the impacted groups

Definition at line 55 of file ReservedBuyingPowerImpact.cs.

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

Common/Securities/Positions/ReservedBuyingPowerImpact.cs

Public Member Functions

Properties