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

49 lines
2.2 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;
using QuantConnect.Interfaces;
namespace QuantConnect.Exceptions
{
/// <summary>
/// Defines an exception interpreter. Interpretations are invoked on <see cref="IAlgorithm.RunTimeError"/>
/// </summary>
public interface IExceptionInterpreter
{
/// <summary>
/// Determines the order that a class that implements this interface should be called
/// </summary>
int Order { get; }
/// <summary>
/// Determines if this interpreter should be applied to the specified exception.
/// </summary>
/// <param name="exception">The exception to check</param>
/// <returns>True if the exception can be interpreted, false otherwise</returns>
bool CanInterpret(Exception exception);
/// <summary>
/// Interprets the specified exception into a new exception
/// </summary>
/// <param name="exception">The exception to be interpreted</param>
/// <param name="innerInterpreter">An interpreter that should be applied to the inner exception.
/// This provides a link back allowing the inner exceptions to be interpreted using the interpreters
/// configured in the <see cref="IExceptionInterpreter"/>. Individual implementations *may* ignore
/// this value if required.</param>
/// <returns>The interpreted exception</returns>
Exception Interpret(Exception exception, IExceptionInterpreter innerInterpreter);
}
}