Lean  $LEAN_TAG$
Messages.Securities.Positions.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 using System.Collections.Generic;
18 using System.Linq;
19 using System.Runtime.CompilerServices;
20 
21 using static QuantConnect.StringExtensions;
22 
23 namespace QuantConnect
24 {
25  /// <summary>
26  /// Provides user-facing message construction methods and static messages for the <see cref="Securities.Positions"/> namespace
27  /// </summary>
28  public static partial class Messages
29  {
30  /// <summary>
31  /// Provides user-facing messages for the <see cref="Securities.Positions.PositionGroup"/> class and its consumers or related classes
32  /// </summary>
33  public static class PositionGroup
34  {
35  /// <summary>
36  /// Returns a string message saying the given quantity is invalid. It also contains the quantities from the
37  /// given positions as well as the unit quantities
38  /// </summary>
39  [MethodImpl(MethodImplOptions.AggressiveInlining)]
40  public static string InvalidQuantity(decimal quantity, IEnumerable<IPosition> positions)
41  {
42  return Invariant($@"The given quantity {quantity
43  } must be equal to the ratio between the quantity and unit quantity for each position. Quantities were {
44  string.Join(", ", positions.Select(position => position.Quantity))}. Unit quantities were {
45  string.Join(", ", positions.Select(position => position.UnitQuantity))}.");
46  }
47  }
48  }
49 }