Lean  $LEAN_TAG$
LossonExtinguishmentofDebtIncomeStatement.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2023 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  *
15 */
16 
17 using System;
18 using System.Linq;
19 using Python.Runtime;
20 using Newtonsoft.Json;
21 using System.Collections.Generic;
23 
25 {
26  /// <summary>
27  /// Loss on extinguishment of debt is the accounting loss that results from a debt extinguishment. A debt shall be accounted for as having been extinguished in a number of circumstances, including when it has been settled through repayment or replacement by another liability. It generally results in an accounting gain or loss. Amount represents the difference between the fair value of the payments made and the carrying amount of the debt at the time of its extinguishment.
28  /// </summary>
30  {
31  /// <summary>
32  /// The default period
33  /// </summary>
34  protected override string DefaultPeriod => "TwelveMonths";
35 
36  /// <summary>
37  /// Gets/sets the ThreeMonths period value for the field
38  /// </summary>
39  [JsonProperty("3M")]
40  public double ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_ThreeMonths);
41 
42  /// <summary>
43  /// Gets/sets the SixMonths period value for the field
44  /// </summary>
45  [JsonProperty("6M")]
46  public double SixMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_SixMonths);
47 
48  /// <summary>
49  /// Gets/sets the NineMonths period value for the field
50  /// </summary>
51  [JsonProperty("9M")]
52  public double NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_NineMonths);
53 
54  /// <summary>
55  /// Gets/sets the TwelveMonths period value for the field
56  /// </summary>
57  [JsonProperty("12M")]
58  public double TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_TwelveMonths);
59 
60  /// <summary>
61  /// Returns true if the field contains a value for the default period
62  /// </summary>
63  public override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_TwelveMonths));
64 
65  /// <summary>
66  /// Returns the default value for the field
67  /// </summary>
68  public override double Value
69  {
70  get
71  {
72  var defaultValue = FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_TwelveMonths);
73  if (!BaseFundamentalDataProvider.IsNone(typeof(double), defaultValue))
74  {
75  return defaultValue;
76  }
77  return base.Value;
78  }
79  }
80 
81  /// <summary>
82  /// Gets a dictionary of period names and values for the field
83  /// </summary>
84  /// <returns>The dictionary of period names and values</returns>
85  public override IReadOnlyDictionary<string, double> GetPeriodValues()
86  {
87  var result = new Dictionary<string, double>();
88  foreach (var kvp in new[] { new Tuple<string, double>("3M",ThreeMonths), new Tuple<string, double>("6M",SixMonths), new Tuple<string, double>("9M",NineMonths), new Tuple<string, double>("12M",TwelveMonths) })
89  {
90  if(!BaseFundamentalDataProvider.IsNone(typeof(double), kvp.Item2))
91  {
92  result[kvp.Item1] = kvp.Item2;
93  }
94  }
95  return result;
96  }
97 
98  /// <summary>
99  /// Gets the value of the field for the requested period
100  /// </summary>
101  /// <param name="period">The requested period</param>
102  /// <returns>The value for the period</returns>
103  public override double GetPeriodValue(string period) => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, Enum.Parse<FundamentalProperty>($"FinancialStatements_IncomeStatement_LossonExtinguishmentofDebt_{ConvertPeriod(period)}"));
104 
105  /// <summary>
106  /// Creates a new empty instance
107  /// </summary>
109  {
110  }
111 
112  /// <summary>
113  /// Creates a new instance for the given time and security
114  /// </summary>
115  public LossonExtinguishmentofDebtIncomeStatement(ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) : base(timeProvider, securityIdentifier)
116  {
117  }
118  }
119 }