Lean  $LEAN_TAG$
DataProviderDataFetchedEventArgs.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 using System;
17 
19 {
20  /// <summary>
21  /// Event arguments for the <see cref="IDataProvider.NewDataRequest"/> event
22  /// </summary>
23  public class DataProviderNewDataRequestEventArgs : EventArgs
24  {
25  /// <summary>
26  /// Path to the fetched data
27  /// </summary>
28  public string Path { get; }
29 
30  /// <summary>
31  /// Whether the data was fetched successfully
32  /// </summary>
33  public bool Succeeded { get; }
34 
35  /// <summary>
36  /// Any error message that occurred during the fetch
37  /// </summary>
38  public string ErrorMessage { get; }
39 
40  /// <summary>
41  /// Initializes a new instance of the <see cref="DataProviderNewDataRequestEventArgs"/> class
42  /// </summary>
43  /// <param name="path">The path to the fetched data</param>
44  /// <param name="succeeded">Whether the data was fetched successfully</param>
45  /// <param name="errorMessage">Any error message that occured during the fetch</param>
46  public DataProviderNewDataRequestEventArgs(string path, bool succeeded, string errorMessage)
47  {
48  Path = path;
49  Succeeded = succeeded;
50  ErrorMessage = errorMessage;
51  }
52  }
53 }