Lean  $LEAN_TAG$
QuantConnect.Securities.ApplyFundsSettlementModelParameters Class Reference

Helper parameters class for ISettlementModel.ApplyFunds(ApplyFundsSettlementModelParameters) More...

Public Member Functions

 ApplyFundsSettlementModelParameters (SecurityPortfolioManager portfolio, Security security, DateTime applicationTimeUtc, CashAmount cashAmount, OrderEvent fill)
 Creates a new instance More...
 

Properties

SecurityPortfolioManager Portfolio [get, set]
 The algorithm portfolio instance More...
 
Security Security [get, set]
 The associated security type More...
 
DateTime UtcTime [get, set]
 The current Utc time More...
 
CashAmount CashAmount [get, set]
 The funds to apply More...
 
OrderEvent Fill [get, set]
 The associated fill event More...
 

Detailed Description

Constructor & Destructor Documentation

◆ ApplyFundsSettlementModelParameters()

QuantConnect.Securities.ApplyFundsSettlementModelParameters.ApplyFundsSettlementModelParameters ( SecurityPortfolioManager  portfolio,
Security  security,
DateTime  applicationTimeUtc,
CashAmount  cashAmount,
OrderEvent  fill 
)

Creates a new instance

Parameters
portfolioThe algorithm's portfolio
securityThe fill's security
applicationTimeUtcThe fill time (in UTC)
cashAmountThe amount to settle
fillThe associated fill

Definition at line 59 of file ApplyFundsSettlementModelParameters.cs.

Property Documentation

◆ Portfolio

SecurityPortfolioManager QuantConnect.Securities.ApplyFundsSettlementModelParameters.Portfolio
getset

The algorithm portfolio instance

Definition at line 29 of file ApplyFundsSettlementModelParameters.cs.

◆ Security

Security QuantConnect.Securities.ApplyFundsSettlementModelParameters.Security
getset

The associated security type

Definition at line 34 of file ApplyFundsSettlementModelParameters.cs.

◆ UtcTime

DateTime QuantConnect.Securities.ApplyFundsSettlementModelParameters.UtcTime
getset

The current Utc time

Definition at line 39 of file ApplyFundsSettlementModelParameters.cs.

◆ CashAmount

CashAmount QuantConnect.Securities.ApplyFundsSettlementModelParameters.CashAmount
getset

The funds to apply

Definition at line 44 of file ApplyFundsSettlementModelParameters.cs.

◆ Fill

OrderEvent QuantConnect.Securities.ApplyFundsSettlementModelParameters.Fill
getset

The associated fill event

Definition at line 49 of file ApplyFundsSettlementModelParameters.cs.


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