Lean  $LEAN_TAG$
ScheduledEventException.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  *
15 */
16 
17 using System;
18 
20 {
21  /// <summary>
22  /// Throw this if there is an exception in the callback function of the scheduled event
23  /// </summary>
24  public class ScheduledEventException : Exception
25  {
26  /// <summary>
27  /// Gets the name of the scheduled event
28  /// </summary>
29  public string ScheduledEventName { get; }
30 
31  /// <summary>
32  /// ScheduledEventException constructor
33  /// </summary>
34  /// <param name="name">The name of the scheduled event</param>
35  /// <param name="message">The exception as a string</param>
36  /// <param name="innerException">The exception that is the cause of the current exception</param>
37  public ScheduledEventException(string name, string message, Exception innerException) : base(message, innerException)
38  {
39  ScheduledEventName = name;
40  }
41  }
42 }