QuantConnect.Data.ConstantDividendYieldModel Class Reference

Constant dividend yield model More...

Inheritance diagram for QuantConnect.Data.ConstantDividendYieldModel:

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...
decimal	GetDividendYield (DateTime date, decimal securityPrice)
	Get dividend yield at given date and security price 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() [1/2]

decimal QuantConnect.Data.ConstantDividendYieldModel.GetDividendYield

(

DateTime

date

)

Get dividend yield by a given date of a given symbol

Parameters

date

The date

Returns

Dividend yield on the given date of the given symbol

Implements QuantConnect.Data.IDividendYieldModel.

Definition at line 40 of file ConstantDividendYieldModel.cs.

GetDividendYield() [2/2]

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

Get dividend yield at given date and security price

Parameters

date	The date
securityPrice	The security price at the given date

Returns

Dividend yield on the given date of the given symbol

Implements QuantConnect.Data.IDividendYieldModel.

Definition at line 51 of file ConstantDividendYieldModel.cs.

---

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

• Common/Data/ConstantDividendYieldModel.cs