This is the simple average of the company's ROE over the last 5 years. Return on equity reveals how much profit a company has earned in comparison to the total amount of shareholder equity found on the balance sheet. 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... | |
| ROE5YrAvg () | |
| Creates a new empty instance More... | |
| ROE5YrAvg (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 | FiveYears => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.OperationRatios_ROE5YrAvg_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.OperationRatios_ROE5YrAvg_FiveYears)) |
| 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 => "FiveYears" |
| 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
This is the simple average of the company's ROE over the last 5 years. Return on equity reveals how much profit a company has earned in comparison to the total amount of shareholder equity found on the balance sheet.
Definition at line 29 of file ROE5YrAvg.cs.
Constructor & Destructor Documentation
◆ ROE5YrAvg() [1/2]
| QuantConnect.Data.Fundamental.ROE5YrAvg.ROE5YrAvg | ( | ) |
Creates a new empty instance
Definition at line 90 of file ROE5YrAvg.cs.
◆ ROE5YrAvg() [2/2]
| QuantConnect.Data.Fundamental.ROE5YrAvg.ROE5YrAvg | ( | ITimeProvider | timeProvider, |
| SecurityIdentifier | securityIdentifier | ||
| ) |
Creates a new instance for the given time and security
Definition at line 97 of file ROE5YrAvg.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 67 of file ROE5YrAvg.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 ROE5YrAvg.cs.
◆ FiveYears
| double QuantConnect.Data.Fundamental.ROE5YrAvg.FiveYears => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.OperationRatios_ROE5YrAvg_FiveYears) |
Gets/sets the FiveYears period value for the field
Definition at line 40 of file ROE5YrAvg.cs.
◆ HasValue
| override bool QuantConnect.Data.Fundamental.ROE5YrAvg.HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.OperationRatios_ROE5YrAvg_FiveYears)) |
Returns true if the field contains a value for the default period
Definition at line 45 of file ROE5YrAvg.cs.
Property Documentation
◆ Value
|
get |
Returns the default value for the field
Definition at line 51 of file ROE5YrAvg.cs.
The documentation for this class was generated from the following file:
- Common/Data/Fundamental/Generated/ROE5YrAvg.cs
