The amount of dividends declared or paid in the period to preferred shareholders, or the amount for which the obligation to pay them dividends arose in the PeriodAsByte. Preferred dividends are the amount required for the current year only, and not for any amount required in past years. More...
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... | |
| PreferredStockDividendsIncomeStatement () | |
| Creates a new empty instance More... | |
| PreferredStockDividendsIncomeStatement (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 | OneMonth => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_OneMonth) |
| Gets/sets the OneMonth period value for the field More... | |
| double | TwoMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_TwoMonths) |
| Gets/sets the TwoMonths period value for the field More... | |
| double | ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_ThreeMonths) |
| Gets/sets the ThreeMonths period value for the field More... | |
| double | SixMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_SixMonths) |
| Gets/sets the SixMonths period value for the field More... | |
| double | NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_NineMonths) |
| Gets/sets the NineMonths period value for the field More... | |
| double | TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_TwelveMonths) |
| Gets/sets the TwelveMonths period value for the field More... | |
| override bool | HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_TwelveMonths)) |
| 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 => "TwelveMonths" |
| 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 amount of dividends declared or paid in the period to preferred shareholders, or the amount for which the obligation to pay them dividends arose in the PeriodAsByte. Preferred dividends are the amount required for the current year only, and not for any amount required in past years.
Definition at line 29 of file PreferredStockDividendsIncomeStatement.cs.
Constructor & Destructor Documentation
◆ PreferredStockDividendsIncomeStatement() [1/2]
| QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.PreferredStockDividendsIncomeStatement | ( | ) |
Creates a new empty instance
Definition at line 120 of file PreferredStockDividendsIncomeStatement.cs.
◆ PreferredStockDividendsIncomeStatement() [2/2]
| QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.PreferredStockDividendsIncomeStatement | ( | ITimeProvider | timeProvider, |
| SecurityIdentifier | securityIdentifier | ||
| ) |
Creates a new instance for the given time and security
Definition at line 127 of file PreferredStockDividendsIncomeStatement.cs.
Member Function Documentation
◆ 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 97 of file PreferredStockDividendsIncomeStatement.cs.
◆ GetPeriodValue()
|
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
|
protected |
The default period
Definition at line 34 of file PreferredStockDividendsIncomeStatement.cs.
◆ OneMonth
| double QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.OneMonth => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_OneMonth) |
Gets/sets the OneMonth period value for the field
Definition at line 40 of file PreferredStockDividendsIncomeStatement.cs.
◆ TwoMonths
| double QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.TwoMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_TwoMonths) |
Gets/sets the TwoMonths period value for the field
Definition at line 46 of file PreferredStockDividendsIncomeStatement.cs.
◆ ThreeMonths
| double QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_ThreeMonths) |
Gets/sets the ThreeMonths period value for the field
Definition at line 52 of file PreferredStockDividendsIncomeStatement.cs.
◆ SixMonths
| double QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.SixMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_SixMonths) |
Gets/sets the SixMonths period value for the field
Definition at line 58 of file PreferredStockDividendsIncomeStatement.cs.
◆ NineMonths
| double QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_NineMonths) |
Gets/sets the NineMonths period value for the field
Definition at line 64 of file PreferredStockDividendsIncomeStatement.cs.
◆ TwelveMonths
| double QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_TwelveMonths) |
Gets/sets the TwelveMonths period value for the field
Definition at line 70 of file PreferredStockDividendsIncomeStatement.cs.
◆ HasValue
| override bool QuantConnect.Data.Fundamental.PreferredStockDividendsIncomeStatement.HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_PreferredStockDividends_TwelveMonths)) |
Returns true if the field contains a value for the default period
Definition at line 75 of file PreferredStockDividendsIncomeStatement.cs.
Property Documentation
◆ Value
|
get |
Returns the default value for the field
Definition at line 81 of file PreferredStockDividendsIncomeStatement.cs.
The documentation for this class was generated from the following file:
- Common/Data/Fundamental/Generated/PreferredStockDividendsIncomeStatement.cs
