The nature of the period covered by an individual set of financial results. The output can be: Quarter, Semi-annual or Annual. Assuming a 12-month fiscal year, quarter typically covers a three-month period, semi-annual a six-month period, and annual a twelve-month period. Annual could cover results collected either from preliminary results or an annual report More...

Inheritance diagram for QuantConnect.Data.Fundamental.EarningReportsPeriodType:

[legend]

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

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

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

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

Public Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
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
string	OneMonth => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_OneMonth)
	Gets/sets the OneMonth period value for the field More...

string	TwoMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_TwoMonths)
	Gets/sets the TwoMonths period value for the field More...

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

string	SixMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_SixMonths)
	Gets/sets the SixMonths period value for the field More...

string	NineMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_NineMonths)
	Gets/sets the NineMonths period value for the field More...

string	TwelveMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_TwelveMonths)
	Gets/sets the TwelveMonths period value for the field More...

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

Public Attributes inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
virtual T	Value
	Returns the default value for the field More...

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

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

Properties inherited from QuantConnect.Data.Fundamental.MultiPeriodField< string >
static T	NoValue `[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< string >
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< string >
	MultiPeriodField ()
	Creates an empty instance More...

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

	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...

Detailed Description

The nature of the period covered by an individual set of financial results. The output can be: Quarter, Semi-annual or Annual. Assuming a 12-month fiscal year, quarter typically covers a three-month period, semi-annual a six-month period, and annual a twelve-month period. Annual could cover results collected either from preliminary results or an annual report

Definition at line 29 of file EarningReportsPeriodType.cs.

Constructor & Destructor Documentation

◆ EarningReportsPeriodType() [1/2]

QuantConnect.Data.Fundamental.EarningReportsPeriodType.EarningReportsPeriodType ( )

Creates a new empty instance

Definition at line 120 of file EarningReportsPeriodType.cs.

◆ EarningReportsPeriodType() [2/2]

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

Creates a new instance for the given time and security

Definition at line 127 of file EarningReportsPeriodType.cs.

Member Function Documentation

◆ GetPeriodValues()

override IReadOnlyDictionary<string, string> QuantConnect.Data.Fundamental.EarningReportsPeriodType.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< string >.

Definition at line 97 of file EarningReportsPeriodType.cs.

Here is the call graph for this function:

◆ GetPeriodValue()

override string QuantConnect.Data.Fundamental.EarningReportsPeriodType.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< string >.

Member Data Documentation

◆ DefaultPeriod

override string QuantConnect.Data.Fundamental.EarningReportsPeriodType.DefaultPeriod => "ThreeMonths"

protected

The default period

Definition at line 34 of file EarningReportsPeriodType.cs.

◆ OneMonth

string QuantConnect.Data.Fundamental.EarningReportsPeriodType.OneMonth => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_OneMonth)

Gets/sets the OneMonth period value for the field

Definition at line 40 of file EarningReportsPeriodType.cs.

◆ TwoMonths

string QuantConnect.Data.Fundamental.EarningReportsPeriodType.TwoMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_TwoMonths)

Gets/sets the TwoMonths period value for the field

Definition at line 46 of file EarningReportsPeriodType.cs.

◆ ThreeMonths

string QuantConnect.Data.Fundamental.EarningReportsPeriodType.ThreeMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_ThreeMonths)

Gets/sets the ThreeMonths period value for the field

Definition at line 52 of file EarningReportsPeriodType.cs.

◆ SixMonths

string QuantConnect.Data.Fundamental.EarningReportsPeriodType.SixMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_SixMonths)

Gets/sets the SixMonths period value for the field

Definition at line 58 of file EarningReportsPeriodType.cs.

◆ NineMonths

string QuantConnect.Data.Fundamental.EarningReportsPeriodType.NineMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_NineMonths)

Gets/sets the NineMonths period value for the field

Definition at line 64 of file EarningReportsPeriodType.cs.

◆ TwelveMonths

string QuantConnect.Data.Fundamental.EarningReportsPeriodType.TwelveMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_TwelveMonths)

Gets/sets the TwelveMonths period value for the field

Definition at line 70 of file EarningReportsPeriodType.cs.

◆ HasValue

override bool QuantConnect.Data.Fundamental.EarningReportsPeriodType.HasValue => !BaseFundamentalDataProvider.IsNone(typeof(string), FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.EarningReports_PeriodType_ThreeMonths))

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

Definition at line 75 of file EarningReportsPeriodType.cs.

Property Documentation

◆ Value

override string QuantConnect.Data.Fundamental.EarningReportsPeriodType.Value

get

Returns the default value for the field

Definition at line 81 of file EarningReportsPeriodType.cs.

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

Common/Data/Fundamental/Generated/EarningReportsPeriodType.cs

Public Member Functions

Public Attributes

Protected Attributes

Properties

Additional Inherited Members