GainLossOnInvestmentSecuritiesCashFlowStatement
GainLossOnInvestmentSecuritiesCashFlowStatement()
GainLossOnInvestmentSecuritiesCashFlowStatement(
time_provider: ITimeProvider,
security_identifier: SecurityIdentifier,
)
Bases: MultiPeriodField
This item represents the net total realized gain (loss) included in earnings for the period as a result of selling or holding marketable securities categorized as trading, available-for-sale, or held-to-maturity, including the unrealized holding gain or loss of held-to- maturity securities transferred to the trading security category and the cumulative unrealized gain or loss which was included in other comprehensive income (a separate component of shareholders' equity) for available-for-sale securities transferred to trading securities during the PeriodAsByte. Additionally, this item would include any losses recognized for other than temporary impairments of the subject investments in debt and equity securities.
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.
one_month: float
Gets/sets the OneMonth period value for the field
two_months: float
Gets/sets the TwoMonths period value for the field
three_months: float
Gets/sets the ThreeMonths period value for the field
six_months: float
Gets/sets the SixMonths period value for the field
nine_months: float
Gets/sets the NineMonths 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.