Lean  $LEAN_TAG$
QuantConnect.Data.Fundamental.BalanceSheetFileDate Class Reference

Filing date of the Balance Sheet More...

Inheritance diagram for QuantConnect.Data.Fundamental.BalanceSheetFileDate:
[legend]

Public Member Functions

override IReadOnlyDictionary< string, DateTime > GetPeriodValues ()
 Gets a dictionary of period names and values for the field More...
 
override DateTime GetPeriodValue (string period)
 Gets the value of the field for the requested period More...
 
 BalanceSheetFileDate ()
 Creates a new empty instance More...
 
 BalanceSheetFileDate (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
 Creates a new instance for the given time and security More...
 
- Public Member Functions inherited from QuantConnect.Data.Fundamental.MultiPeriodField< DateTime >
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

DateTime OneMonth => FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_OneMonth)
 Gets/sets the OneMonth period value for the field More...
 
DateTime ThreeMonths => FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_ThreeMonths)
 Gets/sets the SixMonths period value for the field More...
 
DateTime TwelveMonths => FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_TwelveMonths)
 Gets/sets the TwelveMonths period value for the field More...
 
override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(DateTime), FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_TwelveMonths))
 Returns true if the field contains a value for the default period More...
 
- Public Attributes inherited from QuantConnect.Data.Fundamental.MultiPeriodField< DateTime >
virtual T Value
 Returns the default value for the field More...
 

Protected Attributes

override string DefaultPeriod => "TwelveMonths"
 The default period More...
 

Properties

override DateTime Value [get]
 Returns the default value for the field More...
 
- Properties inherited from QuantConnect.Data.Fundamental.MultiPeriodField< DateTime >
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< DateTime >
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< DateTime >
 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

Filing date of the Balance Sheet

Definition at line 29 of file BalanceSheetFileDate.cs.

Constructor & Destructor Documentation

◆ BalanceSheetFileDate() [1/2]

QuantConnect.Data.Fundamental.BalanceSheetFileDate.BalanceSheetFileDate ( )

Creates a new empty instance

Definition at line 102 of file BalanceSheetFileDate.cs.

◆ BalanceSheetFileDate() [2/2]

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

Creates a new instance for the given time and security

Definition at line 109 of file BalanceSheetFileDate.cs.

Member Function Documentation

◆ GetPeriodValues()

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

Definition at line 79 of file BalanceSheetFileDate.cs.

Here is the call graph for this function:

◆ GetPeriodValue()

override DateTime QuantConnect.Data.Fundamental.BalanceSheetFileDate.GetPeriodValue ( string  period)
virtual

Gets the value of the field for the requested period

Parameters
periodThe requested period
Returns
The value for the period

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

Member Data Documentation

◆ DefaultPeriod

override string QuantConnect.Data.Fundamental.BalanceSheetFileDate.DefaultPeriod => "TwelveMonths"
protected

The default period

Definition at line 34 of file BalanceSheetFileDate.cs.

◆ OneMonth

DateTime QuantConnect.Data.Fundamental.BalanceSheetFileDate.OneMonth => FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_OneMonth)

Gets/sets the OneMonth period value for the field

Definition at line 40 of file BalanceSheetFileDate.cs.

◆ ThreeMonths

DateTime QuantConnect.Data.Fundamental.BalanceSheetFileDate.ThreeMonths => FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_ThreeMonths)

Gets/sets the SixMonths period value for the field

Definition at line 46 of file BalanceSheetFileDate.cs.

◆ TwelveMonths

DateTime QuantConnect.Data.Fundamental.BalanceSheetFileDate.TwelveMonths => FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_TwelveMonths)

Gets/sets the TwelveMonths period value for the field

Definition at line 52 of file BalanceSheetFileDate.cs.

◆ HasValue

override bool QuantConnect.Data.Fundamental.BalanceSheetFileDate.HasValue => !BaseFundamentalDataProvider.IsNone(typeof(DateTime), FundamentalService.Get<DateTime>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_BSFileDate_TwelveMonths))

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

Definition at line 57 of file BalanceSheetFileDate.cs.

Property Documentation

◆ Value

override DateTime QuantConnect.Data.Fundamental.BalanceSheetFileDate.Value
get

Returns the default value for the field

Definition at line 63 of file BalanceSheetFileDate.cs.


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