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

The carrying amount as of the balance sheet date of all assets obtained in full or partial satisfaction of a debt arrangement through foreclosure proceedings or defeasance; includes real and personal property; equity interests in corporations, partnerships, and joint ventures; and beneficial interest in trusts. This item is typically typically available for bank industry. More...

Inheritance diagram for QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet:
[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...
 
 ForeclosedAssetsBalanceSheet ()
 Creates a new empty instance More...
 
 ForeclosedAssetsBalanceSheet (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 ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_ForeclosedAssets_ThreeMonths)
 Gets/sets the ThreeMonths period value for the field More...
 
double NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_ForeclosedAssets_NineMonths)
 Gets/sets the NineMonths period value for the field More...
 
double TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_ForeclosedAssets_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_BalanceSheet_ForeclosedAssets_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 carrying amount as of the balance sheet date of all assets obtained in full or partial satisfaction of a debt arrangement through foreclosure proceedings or defeasance; includes real and personal property; equity interests in corporations, partnerships, and joint ventures; and beneficial interest in trusts. This item is typically typically available for bank industry.

Definition at line 29 of file ForeclosedAssetsBalanceSheet.cs.

Constructor & Destructor Documentation

◆ ForeclosedAssetsBalanceSheet() [1/2]

QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet.ForeclosedAssetsBalanceSheet ( )

Creates a new empty instance

Definition at line 102 of file ForeclosedAssetsBalanceSheet.cs.

◆ ForeclosedAssetsBalanceSheet() [2/2]

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

Creates a new instance for the given time and security

Definition at line 109 of file ForeclosedAssetsBalanceSheet.cs.

Member Function Documentation

◆ GetPeriodValues()

override IReadOnlyDictionary<string, double> QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet.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 79 of file ForeclosedAssetsBalanceSheet.cs.

Here is the call graph for this function:

◆ GetPeriodValue()

override double QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet.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< T >.

Member Data Documentation

◆ DefaultPeriod

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

The default period

Definition at line 34 of file ForeclosedAssetsBalanceSheet.cs.

◆ ThreeMonths

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

Gets/sets the ThreeMonths period value for the field

Definition at line 40 of file ForeclosedAssetsBalanceSheet.cs.

◆ NineMonths

double QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet.NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_ForeclosedAssets_NineMonths)

Gets/sets the NineMonths period value for the field

Definition at line 46 of file ForeclosedAssetsBalanceSheet.cs.

◆ TwelveMonths

double QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet.TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_ForeclosedAssets_TwelveMonths)

Gets/sets the TwelveMonths period value for the field

Definition at line 52 of file ForeclosedAssetsBalanceSheet.cs.

◆ HasValue

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

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

Definition at line 57 of file ForeclosedAssetsBalanceSheet.cs.

Property Documentation

◆ Value

override double QuantConnect.Data.Fundamental.ForeclosedAssetsBalanceSheet.Value
get

Returns the default value for the field

Definition at line 63 of file ForeclosedAssetsBalanceSheet.cs.


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