The growth in the company's dividends per share (DPS) on a percentage basis. Morningstar calculates the annualized growth percentage based on the underlying DPS from its dividend database. Morningstar collects its DPS from company filings and reports, as well as from third party sources. More...

Inheritance diagram for QuantConnect.Data.Fundamental.DPSGrowth:

[legend]

Public Member Functions
override IReadOnlyDictionary< string, double >	GetPeriodValues ()
	Gets a dictionary of period names and values for the field More...

override double	GetPeriodValue (string period)
	Gets the value of the field for the requested period More...

	DPSGrowth ()
	Creates a new empty instance More...

	DPSGrowth (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
	Creates a new instance for the given time and security More...

Public Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< T >
virtual bool	HasPeriodValue (string period)
	Returns true if the field contains a value for the requested period More...

IEnumerable< string >	GetPeriodNames ()
	Gets the list of available period names for the field More...

bool	HasValues ()
	Returns true if the field has at least one value for one period More...

override string	ToString ()
	Returns a string that represents the current object. More...

Public Attributes
double	OneYear => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_OneYear)
	Gets/sets the OneYear period value for the field More...

double	ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_ThreeMonths)
	Gets/sets the ThreeMonths period value for the field More...

double	ThreeYears => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_ThreeYears)
	Gets/sets the ThreeYears period value for the field More...

double	FiveYears => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_FiveYears)
	Gets/sets the FiveYears period value for the field More...

override bool	HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_OneYear))
	Returns true if the field contains a value for the default period More...

Public Attributes inherited from QuantConnect.Data.Fundamental.MultiPeriodField< T >
virtual T	Value => GetPeriodValues().Select(x => x.Value).DefaultIfEmpty(NoValue).FirstOrDefault()
	Returns the default value for the field More...

Protected Attributes
override string	DefaultPeriod => "OneYear"
	The default period More...

Properties
override double	Value `[get]`
	Returns the default value for the field More...

Properties inherited from QuantConnect.Data.Fundamental.MultiPeriodField< T >
static T	NoValue = BaseFundamentalDataProvider.GetDefault<T>() `[get]`
	No Value More...

ITimeProvider	TimeProvider `[get]`
	The time provider instance to use More...

abstract string	DefaultPeriod `[get]`
	The default period More...

SecurityIdentifier	SecurityIdentifier `[get, set]`
	The target security identifier More...

abstract bool	HasValue `[get]`
	Returns true if the field contains a value for the default period More...

Additional Inherited Members
Static Public Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< T >
static implicit	operator T (MultiPeriodField< T > instance)
	Returns the default value for the field More...

static implicit	operator decimal (MultiPeriodField instance)
	Returns the default value for the field More...

Protected Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< T >
	MultiPeriodField ()
	Creates an empty instance More...

	MultiPeriodField (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
	Creates a new instance More...

string	ConvertPeriod (string period)
	Returns a string that represents the current object. More...

	MultiPeriodField ()
	Creates an empty instance More...

	MultiPeriodField (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
	Creates a new instance More...

Detailed Description

The growth in the company's dividends per share (DPS) on a percentage basis. Morningstar calculates the annualized growth percentage based on the underlying DPS from its dividend database. Morningstar collects its DPS from company filings and reports, as well as from third party sources.

Definition at line 29 of file DPSGrowth.cs.

Constructor & Destructor Documentation

◆ DPSGrowth() [1/2]

QuantConnect.Data.Fundamental.DPSGrowth.DPSGrowth ( )

Creates a new empty instance

Definition at line 108 of file DPSGrowth.cs.

◆ DPSGrowth() [2/2]

QuantConnect.Data.Fundamental.DPSGrowth.DPSGrowth	(	ITimeProvider	timeProvider,
		SecurityIdentifier	securityIdentifier
	)

Creates a new instance for the given time and security

Definition at line 115 of file DPSGrowth.cs.

Member Function Documentation

◆ GetPeriodValues()

override IReadOnlyDictionary<string, double> QuantConnect.Data.Fundamental.DPSGrowth.GetPeriodValues ( )

virtual

Gets a dictionary of period names and values for the field

Returns: The dictionary of period names and values

Implements QuantConnect.Data.Fundamental.MultiPeriodField< T >.

Definition at line 85 of file DPSGrowth.cs.

Here is the call graph for this function:

◆ GetPeriodValue()

override double QuantConnect.Data.Fundamental.DPSGrowth.GetPeriodValue ( string period )

virtual

Gets the value of the field for the requested period

Parameters

period The requested period

Returns: The value for the period

Implements QuantConnect.Data.Fundamental.MultiPeriodField< T >.

Member Data Documentation

◆ DefaultPeriod

override string QuantConnect.Data.Fundamental.DPSGrowth.DefaultPeriod => "OneYear"

protected

The default period

Definition at line 34 of file DPSGrowth.cs.

◆ OneYear

double QuantConnect.Data.Fundamental.DPSGrowth.OneYear => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_OneYear)

Gets/sets the OneYear period value for the field

Definition at line 40 of file DPSGrowth.cs.

◆ ThreeMonths

double QuantConnect.Data.Fundamental.DPSGrowth.ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_ThreeMonths)

Gets/sets the ThreeMonths period value for the field

Definition at line 46 of file DPSGrowth.cs.

◆ ThreeYears

double QuantConnect.Data.Fundamental.DPSGrowth.ThreeYears => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_ThreeYears)

Gets/sets the ThreeYears period value for the field

Definition at line 52 of file DPSGrowth.cs.

◆ FiveYears

double QuantConnect.Data.Fundamental.DPSGrowth.FiveYears => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_FiveYears)

Gets/sets the FiveYears period value for the field

Definition at line 58 of file DPSGrowth.cs.

◆ HasValue

override bool QuantConnect.Data.Fundamental.DPSGrowth.HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningRatios_DPSGrowth_OneYear))

Returns true if the field contains a value for the default period

Definition at line 63 of file DPSGrowth.cs.

Property Documentation

◆ Value

override double QuantConnect.Data.Fundamental.DPSGrowth.Value

get

Returns the default value for the field

Definition at line 69 of file DPSGrowth.cs.

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

Common/Data/Fundamental/Generated/DPSGrowth.cs

Public Member Functions

Public Attributes

Protected Attributes

Properties

Additional Inherited Members