Lean  $LEAN_TAG$
EmployeeBenefitsBalanceSheet.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  /// Carrying amount as of the balance sheet date of the portion of the obligations recognized for the various benefits provided to former or inactive employees, their beneficiaries, and covered dependents after employment but before retirement.
28  /// </summary>
30  {
31  /// <summary>
32  /// The default period
33  /// </summary>
34  protected override string DefaultPeriod => "TwelveMonths";
35 
36  /// <summary>
37  /// Gets/sets the TwoMonths period value for the field
38  /// </summary>
39  [JsonProperty("2M")]
40  public double TwoMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_TwoMonths);
41 
42  /// <summary>
43  /// Gets/sets the ThreeMonths period value for the field
44  /// </summary>
45  [JsonProperty("3M")]
46  public double ThreeMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_ThreeMonths);
47 
48  /// <summary>
49  /// Gets/sets the SixMonths period value for the field
50  /// </summary>
51  [JsonProperty("6M")]
52  public double SixMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_SixMonths);
53 
54  /// <summary>
55  /// Gets/sets the NineMonths period value for the field
56  /// </summary>
57  [JsonProperty("9M")]
58  public double NineMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_NineMonths);
59 
60  /// <summary>
61  /// Gets/sets the TwelveMonths period value for the field
62  /// </summary>
63  [JsonProperty("12M")]
64  public double TwelveMonths => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_TwelveMonths);
65 
66  /// <summary>
67  /// Returns true if the field contains a value for the default period
68  /// </summary>
69  public override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_TwelveMonths));
70 
71  /// <summary>
72  /// Returns the default value for the field
73  /// </summary>
74  public override double Value
75  {
76  get
77  {
78  var defaultValue = FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_EmployeeBenefits_TwelveMonths);
79  if (!BaseFundamentalDataProvider.IsNone(typeof(double), defaultValue))
80  {
81  return defaultValue;
82  }
83  return base.Value;
84  }
85  }
86 
87  /// <summary>
88  /// Gets a dictionary of period names and values for the field
89  /// </summary>
90  /// <returns>The dictionary of period names and values</returns>
91  public override IReadOnlyDictionary<string, double> GetPeriodValues()
92  {
93  var result = new Dictionary<string, double>();
94  foreach (var kvp in new[] { new Tuple<string, double>("2M",TwoMonths), new Tuple<string, double>("3M",ThreeMonths), new Tuple<string, double>("6M",SixMonths), new Tuple<string, double>("9M",NineMonths), new Tuple<string, double>("12M",TwelveMonths) })
95  {
96  if(!BaseFundamentalDataProvider.IsNone(typeof(double), kvp.Item2))
97  {
98  result[kvp.Item1] = kvp.Item2;
99  }
100  }
101  return result;
102  }
103 
104  /// <summary>
105  /// Gets the value of the field for the requested period
106  /// </summary>
107  /// <param name="period">The requested period</param>
108  /// <returns>The value for the period</returns>
109  public override double GetPeriodValue(string period) => FundamentalService.Get<double>(TimeProvider.GetUtcNow(), SecurityIdentifier, Enum.Parse<FundamentalProperty>($"FinancialStatements_BalanceSheet_EmployeeBenefits_{ConvertPeriod(period)}"));
110 
111  /// <summary>
112  /// Creates a new empty instance
113  /// </summary>
115  {
116  }
117 
118  /// <summary>
119  /// Creates a new instance for the given time and security
120  /// </summary>
121  public EmployeeBenefitsBalanceSheet(ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) : base(timeProvider, securityIdentifier)
122  {
123  }
124  }
125 }