QuantConnect.Securities.ISettlementModel Interface Reference

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

Inheritance diagram for QuantConnect.Securities.ISettlementModel:

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

Detailed Description

Represents the model responsible for applying cash settlement rules

Definition at line 21 of file ISettlementModel.cs.

Member Function Documentation

ApplyFunds()

void QuantConnect.Securities.ISettlementModel.ApplyFunds

(

ApplyFundsSettlementModelParameters

applyFundsParameters

)

Applies cash settlement rules

Parameters

applyFundsParameters

The funds application parameters

Implemented in QuantConnect.Securities.DelayedSettlementModel, QuantConnect.Python.SettlementModelPythonWrapper, QuantConnect.Securities.Future.FutureSettlementModel, QuantConnect.Securities.AccountCurrencyImmediateSettlementModel, and QuantConnect.Securities.ImmediateSettlementModel.

Here is the caller graph for this function:

Scan()

void QuantConnect.Securities.ISettlementModel.Scan

(

ScanSettlementModelParameters

settlementParameters

)

Scan for pending settlements

Parameters

settlementParameters

The settlement parameters

Implemented in QuantConnect.Securities.DelayedSettlementModel, QuantConnect.Securities.Future.FutureSettlementModel, QuantConnect.Python.SettlementModelPythonWrapper, and QuantConnect.Securities.ImmediateSettlementModel.

GetUnsettledCash()

CashAmount QuantConnect.Securities.ISettlementModel.GetUnsettledCash

(

)

Gets the unsettled cash amount for the security

Implemented in QuantConnect.Securities.DelayedSettlementModel, QuantConnect.Python.SettlementModelPythonWrapper, and QuantConnect.Securities.ImmediateSettlementModel.

---

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

• Common/Securities/ISettlementModel.cs