Lean  $LEAN_TAG$
Public Member Functions | List of all members
QuantConnect.Securities.DelayedSettlementModel Class Reference

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

Inheritance diagram for QuantConnect.Securities.DelayedSettlementModel:
[legend]

Public Member Functions

 DelayedSettlementModel (int numberOfDays, TimeSpan timeOfDay)
 Creates an instance of the DelayedSettlementModel class More...
 
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

This model applies cash settlement after T+N days

Definition at line 26 of file DelayedSettlementModel.cs.

Constructor & Destructor Documentation

◆ DelayedSettlementModel()

QuantConnect.Securities.DelayedSettlementModel.DelayedSettlementModel ( int  numberOfDays,
TimeSpan  timeOfDay 
)

Creates an instance of the DelayedSettlementModel class

Parameters
numberOfDaysThe number of days required for settlement
timeOfDayThe time of day used for settlement

Definition at line 42 of file DelayedSettlementModel.cs.

Member Function Documentation

◆ ApplyFunds()

void QuantConnect.Securities.DelayedSettlementModel.ApplyFunds ( ApplyFundsSettlementModelParameters  applyFundsParameters)

Applies cash settlement rules

Parameters
applyFundsParametersThe funds application parameters

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 53 of file DelayedSettlementModel.cs.

◆ Scan()

void QuantConnect.Securities.DelayedSettlementModel.Scan ( ScanSettlementModelParameters  settlementParameters)

Scan for pending settlements

Parameters
settlementParametersThe settlement parameters

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 102 of file DelayedSettlementModel.cs.

◆ GetUnsettledCash()

CashAmount QuantConnect.Securities.DelayedSettlementModel.GetUnsettledCash ( )

Gets the unsettled cash amount for the security

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 125 of file DelayedSettlementModel.cs.

Here is the call graph for this function:
The documentation for this class was generated from the following file: