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

59 lines
2.6 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
{
/// <summary>
/// Represents a simple, constant margin model by specifying the percentages of required margin.
/// </summary>
public class SecurityMarginModel : BuyingPowerModel
{
/// <summary>
/// Initializes a new instance of the <see cref="SecurityMarginModel"/> with no leverage (1x)
/// </summary>
public SecurityMarginModel()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="SecurityMarginModel"/>
/// </summary>
/// <param name="initialMarginRequirement">The percentage of an order's absolute cost
/// that must be held in free cash in order to place the order</param>
/// <param name="maintenanceMarginRequirement">The percentage of the holding's absolute
/// cost that must be held in free cash in order to avoid a margin call</param>
/// <param name="requiredFreeBuyingPowerPercent">The percentage used to determine the required
/// unused buying power for the account.</param>
public SecurityMarginModel(
decimal initialMarginRequirement,
decimal maintenanceMarginRequirement,
decimal requiredFreeBuyingPowerPercent
)
: base(initialMarginRequirement, maintenanceMarginRequirement, requiredFreeBuyingPowerPercent)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="SecurityMarginModel"/>
/// </summary>
/// <param name="leverage">The leverage</param>
/// <param name="requiredFreeBuyingPowerPercent">The percentage used to determine the required
/// unused buying power for the account.</param>
public SecurityMarginModel(decimal leverage, decimal requiredFreeBuyingPowerPercent = 0)
: base(leverage, requiredFreeBuyingPowerPercent)
{
}
}
}