QuantConnect.Securities.ImmediateSettlementModel Class Reference

Represents the model responsible for applying cash settlement rules More...

Inheritance diagram for QuantConnect.Securities.ImmediateSettlementModel:

Public Member Functions
virtual void	ApplyFunds (ApplyFundsSettlementModelParameters applyFundsParameters)
	Applies cash settlement rules More...
virtual void	Scan (ScanSettlementModelParameters settlementParameters)
	Scan for pending settlements More...
virtual CashAmount	GetUnsettledCash ()
	Gets the unsettled cash amount for the security More...

Detailed Description

Represents the model responsible for applying cash settlement rules

This model applies cash settlement immediately

Definition at line 22 of file ImmediateSettlementModel.cs.

Member Function Documentation

ApplyFunds()

virtual void QuantConnect.Securities.ImmediateSettlementModel.ApplyFunds ( ApplyFundsSettlementModelParameters  applyFundsParameters )

virtual

Applies cash settlement rules

Parameters

applyFundsParameters

The funds application parameters

Implements QuantConnect.Securities.ISettlementModel.

Reimplemented in QuantConnect.Securities.Future.FutureSettlementModel, and QuantConnect.Securities.AccountCurrencyImmediateSettlementModel.

Definition at line 28 of file ImmediateSettlementModel.cs.

Scan()

virtual void QuantConnect.Securities.ImmediateSettlementModel.Scan ( ScanSettlementModelParameters  settlementParameters )

virtual

Scan for pending settlements

Parameters

settlementParameters

The settlement parameters

Implements QuantConnect.Securities.ISettlementModel.

Reimplemented in QuantConnect.Securities.Future.FutureSettlementModel.

Definition at line 39 of file ImmediateSettlementModel.cs.

GetUnsettledCash()

virtual CashAmount QuantConnect.Securities.ImmediateSettlementModel.GetUnsettledCash ( )

virtual

Gets the unsettled cash amount for the security

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 46 of file ImmediateSettlementModel.cs.

---

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

• Common/Securities/ImmediateSettlementModel.cs