QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider Class Reference

Event provider who will emit Dividend events More...

Inheritance diagram for QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider:

Public Member Functions
void	Initialize (SubscriptionDataConfig config, IFactorFileProvider factorFileProvider, IMapFileProvider mapFileProvider, DateTime startTime)
	Initializes this instance More...
virtual IEnumerable< BaseData >	GetEvents (NewTradableDateEventArgs eventArgs)
	Check for dividends and returns them More...

Protected Member Functions
void	InitializeFactorFile ()
	Initializes the factor file to use More...

Properties
CorporateFactorProvider	FactorFile [get]
	The current instance being used More...
SubscriptionDataConfig	Config [get]
	The associated configuration More...

Detailed Description

Event provider who will emit Dividend events

Definition at line 29 of file DividendEventProvider.cs.

Member Function Documentation

Initialize()

void QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider.Initialize	(	SubscriptionDataConfig	config,
		IFactorFileProvider	factorFileProvider,
		IMapFileProvider	mapFileProvider,
		DateTime	startTime
	)

Initializes this instance

Parameters

config	The SubscriptionDataConfig
factorFileProvider	The factor file provider to use
mapFileProvider	The Data.Auxiliary.MapFile provider to use
startTime	Start date for the data request

Implements QuantConnect.Lean.Engine.DataFeeds.Enumerators.ITradableDateEventProvider.

Definition at line 55 of file DividendEventProvider.cs.

Here is the call graph for this function:

GetEvents()

virtual IEnumerable<BaseData> QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider.GetEvents ( NewTradableDateEventArgs  eventArgs )

virtual

Check for dividends and returns them

Parameters

eventArgs

The new tradable day event arguments

Returns

New Dividend event if any

Implements QuantConnect.Lean.Engine.DataFeeds.Enumerators.ITradableDateEventProvider.

Reimplemented in QuantConnect.Lean.Engine.DataFeeds.Enumerators.LiveDividendEventProvider.

Definition at line 72 of file DividendEventProvider.cs.

Here is the call graph for this function:

InitializeFactorFile()

void QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider.InitializeFactorFile ( )

protected

Initializes the factor file to use

Definition at line 113 of file DividendEventProvider.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

FactorFile

CorporateFactorProvider QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider.FactorFile

getprotected

The current instance being used

Definition at line 41 of file DividendEventProvider.cs.

Config

SubscriptionDataConfig QuantConnect.Lean.Engine.DataFeeds.Enumerators.DividendEventProvider.Config

getprotected

The associated configuration

Definition at line 46 of file DividendEventProvider.cs.

---

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

• Engine/DataFeeds/Enumerators/DividendEventProvider.cs