Files
quantconnect--lean/Common/Messages/Messages.Orders.OptionExercise.cs
2026-07-13 13:02:50 +08:00

57 lines
2.3 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 System.Runtime.CompilerServices;
using QuantConnect.Securities.Option;
namespace QuantConnect
{
/// <summary>
/// Provides user-facing message construction methods and static messages for the <see cref="Orders.OptionExercise"/> namespace
/// </summary>
public static partial class Messages
{
/// <summary>
/// Provides user-facing messages for the <see cref="Orders.OptionExercise.DefaultExerciseModel"/> class and its consumers or related classes
/// </summary>
public static class DefaultExerciseModel
{
/// <summary>
/// String message saying: Option Assignment
/// </summary>
public static string OptionAssignment = "Option Assignment";
/// <summary>
/// String message saying: Option exercise
/// </summary>
public static string OptionExercise = "Option Exercise";
/// <summary>
/// Returns a string message containing basic information such as if it's
/// an assignment or an exercise, if it's ITM or OTM and the underlying option price
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static string ContractHoldingsAdjustmentFillTag(bool inTheMoney, bool isAssignment, Option option)
{
var action = isAssignment ? "Assigned" : "Automatic Exercise";
var tag = inTheMoney ? action : "OTM";
return $"{tag}. Underlying: {option.Underlying.Price.ToStringInvariant()}";
}
}
}
}