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

The carrying amounts of cash and cash equivalent items, which are restricted as to withdrawal or usage. Restrictions may include legally restricted deposits held as compensating balances against short-term borrowing arrangements, contracts entered into with others, or entity statements of intention with regard to particular deposits; however, time deposits and short-term certificates of deposit are not generally included in legally restricted deposits. Excludes compensating balance arrangements that are not agreements, which legally restrict the use of cash amounts shown on the balance sheet. For a classified balance sheet, represents the current portion only (the non-current portion has a separate concept); for an unclassified balance sheet represents the entire amount. This item is usually not available for bank and insurance industries. More...

Inheritance diagram for QuantConnect.Data.Fundamental.RestrictedCashBalanceSheet:
[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...
 
 RestrictedCashBalanceSheet ()
 Creates a new empty instance More...
 
 RestrictedCashBalanceSheet (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_BalanceSheet_RestrictedCash_OneMonth)
 Gets/sets the OneMonth period value for the field More...
 
double TwoMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_TwoMonths)
 Gets/sets the TwoMonths period value for the field More...
 
double ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_ThreeMonths)
 Gets/sets the ThreeMonths period value for the field More...
 
double SixMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_SixMonths)
 Gets/sets the SixMonths period value for the field More...
 
double NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_NineMonths)
 Gets/sets the NineMonths period value for the field More...
 
double TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_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_RestrictedCash_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 amounts of cash and cash equivalent items, which are restricted as to withdrawal or usage. Restrictions may include legally restricted deposits held as compensating balances against short-term borrowing arrangements, contracts entered into with others, or entity statements of intention with regard to particular deposits; however, time deposits and short-term certificates of deposit are not generally included in legally restricted deposits. Excludes compensating balance arrangements that are not agreements, which legally restrict the use of cash amounts shown on the balance sheet. For a classified balance sheet, represents the current portion only (the non-current portion has a separate concept); for an unclassified balance sheet represents the entire amount. This item is usually not available for bank and insurance industries.

Definition at line 29 of file RestrictedCashBalanceSheet.cs.

Constructor & Destructor Documentation

◆ RestrictedCashBalanceSheet() [1/2]

QuantConnect.Data.Fundamental.RestrictedCashBalanceSheet.RestrictedCashBalanceSheet ( )

Creates a new empty instance

Definition at line 120 of file RestrictedCashBalanceSheet.cs.

◆ RestrictedCashBalanceSheet() [2/2]

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

Creates a new instance for the given time and security

Definition at line 127 of file RestrictedCashBalanceSheet.cs.

Member Function Documentation

◆ GetPeriodValues()

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

Here is the call graph for this function:

◆ GetPeriodValue()

override double QuantConnect.Data.Fundamental.RestrictedCashBalanceSheet.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.RestrictedCashBalanceSheet.DefaultPeriod => "TwelveMonths"
protected

The default period

Definition at line 34 of file RestrictedCashBalanceSheet.cs.

◆ OneMonth

double QuantConnect.Data.Fundamental.RestrictedCashBalanceSheet.OneMonth => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_OneMonth)

Gets/sets the OneMonth period value for the field

Definition at line 40 of file RestrictedCashBalanceSheet.cs.

◆ TwoMonths

double QuantConnect.Data.Fundamental.RestrictedCashBalanceSheet.TwoMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_TwoMonths)

Gets/sets the TwoMonths period value for the field

Definition at line 46 of file RestrictedCashBalanceSheet.cs.

◆ ThreeMonths

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

Gets/sets the ThreeMonths period value for the field

Definition at line 52 of file RestrictedCashBalanceSheet.cs.

◆ SixMonths

double QuantConnect.Data.Fundamental.RestrictedCashBalanceSheet.SixMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_RestrictedCash_SixMonths)

Gets/sets the SixMonths period value for the field

Definition at line 58 of file RestrictedCashBalanceSheet.cs.

◆ NineMonths

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

Gets/sets the NineMonths period value for the field

Definition at line 64 of file RestrictedCashBalanceSheet.cs.

◆ TwelveMonths

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

Gets/sets the TwelveMonths period value for the field

Definition at line 70 of file RestrictedCashBalanceSheet.cs.

◆ HasValue

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

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

Definition at line 75 of file RestrictedCashBalanceSheet.cs.

Property Documentation

◆ Value

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

Returns the default value for the field

Definition at line 81 of file RestrictedCashBalanceSheet.cs.


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