ConvertibleLoansTotalBalanceSheet
ConvertibleLoansTotalBalanceSheet()
ConvertibleLoansTotalBalanceSheet(
time_provider: ITimeProvider,
security_identifier: SecurityIdentifier,
)
Bases: MultiPeriodField
Loans that entitles the lender (or the holder of loan debenture) to convert the loan to common or preferred stock (ordinary or preference shares) at a specified rate conversion rate and a specified time frame; in a Non-Differentiated Balance Sheet.
Signature descriptions:
-
Creates a new empty instance
-
Creates a new instance for the given time and security
default_period: str
The default period
This codeEntityType is protected.
three_months: float
Gets/sets the ThreeMonths period value for the field
twelve_months: float
Gets/sets the TwelveMonths period value for the field
has_value: bool
Returns true if the field contains a value for the default period
value: float
Returns the default value for the field
NO_VALUE: QuantConnect_Data_Fundamental_MultiPeriodField_T
No Value
time_provider: ITimeProvider
The time provider instance to use
This codeEntityType is protected.
security_identifier: SecurityIdentifier
The target security identifier
This codeEntityType is protected.
get_period_value(period: str) -> float
Gets the value of the field for the requested period
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
period
|
str
|
The requested period |
required |
Returns:
| Type | Description |
|---|---|
float
|
The value for the period. |
get_period_values() -> IReadOnlyDictionary[str, float]
Gets a dictionary of period names and values for the field
Returns:
| Type | Description |
|---|---|
IReadOnlyDictionary[str, float]
|
The dictionary of period names and values. |
convert_period(period: str) -> str
Returns a string that represents the current object.
This codeEntityType is protected.
get_period_names() -> Iterable[str]
Gets the list of available period names for the field
has_period_value(period: str) -> bool
Returns true if the field contains a value for the requested period
Returns:
| Type | Description |
|---|---|
bool
|
True if the field contains a value for the requested period. |
has_values() -> bool
Returns true if the field has at least one value for one period
to_string() -> str
Returns a string that represents the current object.