Lean  $LEAN_TAG$
OptionInitialMargin.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 
16 using System;
17 
19 {
20  /// <summary>
21  /// Result type for <see cref="Option.OptionStrategyPositionGroupBuyingPowerModel.GetInitialMarginRequirement"/>
22  /// </summary>
24  {
25  /// <summary>
26  /// Gets an instance of <see cref="OptionInitialMargin"/> with zero values
27  /// </summary>
28  public static OptionInitialMargin Zero { get; } = new OptionInitialMargin(0m, 0m);
29 
30  /// <summary>
31  /// The option/strategy premium value in account currency
32  /// </summary>
33  public decimal Premium { get; }
34 
35  /// <summary>
36  /// The initial margin value in account currency, not including the premium in cases that apply (premium debited)
37  /// </summary>
38  public decimal ValueWithoutPremium { get; }
39 
40  /// <summary>
41  /// Initializes a new instance of the <see cref="OptionInitialMargin"/> class
42  /// </summary>
43  /// <param name="value">The initial margin</param>
44  /// <param name="premium">The premium of the option/option strategy</param>
45  public OptionInitialMargin(decimal value, decimal premium)
46  : base(value + Math.Max(premium, 0))
47  {
48  Premium = premium;
49  ValueWithoutPremium = value;
50  }
51  }
52 }