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

75 lines
2.9 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
{
/// <summary>
/// Defines the parameters for <see cref="IBuyingPowerModel.GetBuyingPower"/>
/// </summary>
public class BuyingPowerParameters
{
/// <summary>
/// Gets the security
/// </summary>
public Security Security { get; }
/// <summary>
/// Gets the algorithm's portfolio
/// </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="BuyingPowerParameters"/> class
/// </summary>
/// <param name="portfolio">The algorithm's portfolio</param>
/// <param name="security">The security</param>
/// <param name="direction">The direction to compute buying power in</param>
public BuyingPowerParameters(SecurityPortfolioManager portfolio, Security security, OrderDirection direction)
{
Portfolio = portfolio;
Security = security;
Direction = direction;
}
/// <summary>
/// Creates the result using the specified buying power
/// </summary>
/// <param name="buyingPower">The buying power</param>
/// <param name="currency">The units the buying power is denominated in</param>
/// <returns>The buying power</returns>
public BuyingPower Result(decimal buyingPower, string currency)
{
// TODO: Properly account for 'currency' - not accounted for currently as only performing mechanical refactoring
return new BuyingPower(buyingPower);
}
/// <summary>
/// Creates the result using the specified buying power in units of the account currency
/// </summary>
/// <param name="buyingPower">The buying power</param>
/// <returns>The buying power</returns>
public BuyingPower ResultInAccountCurrency(decimal buyingPower)
{
return new BuyingPower(buyingPower);
}
}
}