Lean  $LEAN_TAG$
ReservedBuyingPowerForPositionGroup.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 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 
17 {
18  /// <summary>
19  /// Defines the result for <see cref="IBuyingPowerModel.GetReservedBuyingPowerForPosition"/>
20  /// </summary>
22  {
23  /// <summary>
24  /// Gets the reserved buying power
25  /// </summary>
26  public decimal AbsoluteUsedBuyingPower { get; }
27 
28  /// <summary>
29  /// Initializes a new instance of the <see cref="ReservedBuyingPowerForPosition"/> class
30  /// </summary>
31  /// <param name="reservedBuyingPowerForPosition">The reserved buying power for the security's holdings</param>
32  public ReservedBuyingPowerForPositionGroup(decimal reservedBuyingPowerForPosition)
33  {
34  AbsoluteUsedBuyingPower = reservedBuyingPowerForPosition;
35  }
36 
37  /// <summary>
38  /// Implicit operator to <see cref="decimal"/> to remove noise
39  /// </summary>
40  public static implicit operator decimal(ReservedBuyingPowerForPositionGroup reservedBuyingPower)
41  {
42  return reservedBuyingPower.AbsoluteUsedBuyingPower;
43  }
44 
45  /// <summary>
46  /// Implicit operator to <see cref="decimal"/> to remove noise
47  /// </summary>
48  public static implicit operator ReservedBuyingPowerForPositionGroup(decimal reservedBuyingPower)
49  {
50  return new ReservedBuyingPowerForPositionGroup(reservedBuyingPower);
51  }
52  }
53 }