Lean  $LEAN_TAG$
IMapFileProvider.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.ComponentModel.Composition;
19 
21 {
22  /// <summary>
23  /// Provides instances of <see cref="MapFileResolver"/> at run time
24  /// </summary>
25  [InheritedExport(typeof(IMapFileProvider))]
26  public interface IMapFileProvider
27  {
28  /// <summary>
29  /// Initializes our MapFileProvider by supplying our dataProvider
30  /// </summary>
31  /// <param name="dataProvider">DataProvider to use</param>
32  void Initialize(IDataProvider dataProvider);
33 
34  /// <summary>
35  /// Gets a <see cref="MapFileResolver"/> representing all the map
36  /// files for the specified market
37  /// </summary>
38  /// <param name="auxiliaryDataKey">Key used to fetch a map file resolver. Specifying market and security type</param>
39  /// <returns>A <see cref="MapFileResolver"/> containing all map files for the specified market</returns>
40  MapFileResolver Get(AuxiliaryDataKey auxiliaryDataKey);
41  }
42 }