Lean  $LEAN_TAG$
QuantConnect.Data.ConstantDividendYieldModel Class Reference

Constant dividend yield model More...

Inheritance diagram for QuantConnect.Data.ConstantDividendYieldModel:
[legend]

Public Member Functions

 ConstantDividendYieldModel (decimal dividendYield)
 Instantiates a ConstantDividendYieldModel with the specified dividend yield More...
 
decimal GetDividendYield (DateTime date)
 Get dividend yield by a given date of a given symbol More...
 

Detailed Description

Constant dividend yield model

Definition at line 23 of file ConstantDividendYieldModel.cs.

Constructor & Destructor Documentation

◆ ConstantDividendYieldModel()

QuantConnect.Data.ConstantDividendYieldModel.ConstantDividendYieldModel ( decimal  dividendYield)

Instantiates a ConstantDividendYieldModel with the specified dividend yield

Definition at line 30 of file ConstantDividendYieldModel.cs.

Member Function Documentation

◆ GetDividendYield()

decimal QuantConnect.Data.ConstantDividendYieldModel.GetDividendYield ( DateTime  date)

Get dividend yield by a given date of a given symbol

Parameters
dateThe date
Returns
Dividend yield on the given date of the given symbol

Implements QuantConnect.Data.IDividendYieldModel.

Definition at line 40 of file ConstantDividendYieldModel.cs.


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