Files
quantconnect--lean/Common/Securities/Positions/PositionGroupBuyingPowerParameters.cs
2026-07-13 13:02:50 +08:00

68 lines
2.5 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.
*/
using QuantConnect.Orders;
namespace QuantConnect.Securities.Positions
{
/// <summary>
/// Defines the parameters for <see cref="IPositionGroupBuyingPowerModel.GetPositionGroupBuyingPower"/>
/// </summary>
public class PositionGroupBuyingPowerParameters
{
/// <summary>
/// Gets the position group
/// </summary>
public IPositionGroup PositionGroup { get; }
/// <summary>
/// Gets the algorithm's portfolio manager
/// </summary>
public SecurityPortfolioManager Portfolio { get; }
/// <summary>
/// Gets the direction in which buying power is to be computed
/// </summary>
public OrderDirection Direction { get; }
/// <summary>
/// Initializes a new instance of the <see cref="PositionGroupBuyingPowerParameters"/> class
/// </summary>
/// <param name="portfolio">The algorithm's portfolio manager</param>
/// <param name="positionGroup">The position group</param>
/// <param name="direction">The direction to compute buying power in</param>
public PositionGroupBuyingPowerParameters(
SecurityPortfolioManager portfolio,
IPositionGroup positionGroup,
OrderDirection direction
)
{
Portfolio = portfolio;
Direction = direction;
PositionGroup = positionGroup;
}
/// <summary>
/// Implicit operator to dependent function to remove noise
/// </summary>
public static implicit operator ReservedBuyingPowerForPositionGroupParameters(
PositionGroupBuyingPowerParameters parameters
)
{
return new ReservedBuyingPowerForPositionGroupParameters(parameters.Portfolio, parameters.PositionGroup);
}
}
}