Lean  $LEAN_TAG$
OptionAssignmentResult.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  /// Data transfer object class
20  /// </summary>
22  {
23  /// <summary>
24  /// No option assignment should take place
25  /// </summary>
26  public static OptionAssignmentResult Null { get; } = new OptionAssignmentResult(decimal.Zero, string.Empty);
27 
28  /// <summary>
29  /// The amount of option holdings to trigger the assignment for
30  /// </summary>
31  public decimal Quantity { get; set; }
32 
33  /// <summary>
34  /// The tag that will be used in the order for the option assignment
35  /// </summary>
36  public string Tag { get; set; }
37 
38  /// <summary>
39  /// Creates a new instance
40  /// </summary>
41  /// <param name="quantity">The quantity to assign</param>
42  /// <param name="tag">The order tag to use</param>
43  public OptionAssignmentResult(decimal quantity, string tag)
44  {
45  Quantity = quantity;
46  Tag = tag;
47  }
48  }
49 }