Files
2026-07-13 13:02:50 +08:00

71 lines
2.8 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace QuantConnect.Securities.Positions
{
/// <summary>
/// Defines a quantity of a security's holdings for inclusion in a position group
/// </summary>
public class Position : IPosition
{
/// <summary>
/// The symbol
/// </summary>
public Symbol Symbol { get; }
/// <summary>
/// The quantity
/// </summary>
public decimal Quantity { get; }
/// <summary>
/// The unit quantity. The unit quantities of a group define the group. For example, a covered
/// call has 100 units of stock and -1 units of call contracts.
/// </summary>
public decimal UnitQuantity { get; }
/// <summary>
/// Initializes a new instance of the <see cref="Position"/> class
/// </summary>
/// <param name="symbol">The symbol</param>
/// <param name="quantity">The quantity</param>
/// <param name="unitQuantity">The position's unit quantity within its group</param>
public Position(Symbol symbol, decimal quantity, decimal unitQuantity)
{
Symbol = symbol;
Quantity = quantity;
UnitQuantity = unitQuantity;
}
/// <summary>
/// Initializes a new instance of the <see cref="Position"/> class using the security's lot size
/// as it's unit quantity. If quantity is null, then the security's holdings quantity is used.
/// </summary>
/// <param name="security">The security</param>
/// <param name="quantity">The quantity, if null, the security's holdings quantity is used</param>
public Position(Security security, decimal? quantity = null)
: this(security.Symbol, quantity ?? security.Holdings.Quantity, security.SymbolProperties.LotSize)
{
}
/// <summary>Returns a string that represents the current object.</summary>
/// <returns>A string that represents the current object.</returns>
public override string ToString()
{
return $"{Symbol}: {Quantity}";
}
}
}