Lean  $LEAN_TAG$
SetupHandlerParameters.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 QuantConnect.Interfaces;
18 using QuantConnect.Lean.Engine.DataFeeds;
19 using QuantConnect.Lean.Engine.RealTime;
20 using QuantConnect.Lean.Engine.Results;
21 using QuantConnect.Lean.Engine.TransactionHandlers;
22 using QuantConnect.Packets;
23 
24 namespace QuantConnect.Lean.Engine.Setup
25 {
26  /// <summary>
27  /// Defines the parameters for <see cref="ISetupHandler"/>
28  /// </summary>
29  public class SetupHandlerParameters
30  {
31  /// <summary>
32  /// Gets the universe selection
33  /// </summary>
34  public UniverseSelection UniverseSelection { get; }
35 
36  /// <summary>
37  /// Gets the algorithm
38  /// </summary>
39  public IAlgorithm Algorithm { get; }
40 
41  /// <summary>
42  /// Gets the Brokerage
43  /// </summary>
44  public IBrokerage Brokerage { get; }
45 
46  /// <summary>
47  /// Gets the algorithm node packet
48  /// </summary>
49  public AlgorithmNodePacket AlgorithmNodePacket { get; }
50 
51  /// <summary>
52  /// Gets the algorithm node packet
53  /// </summary>
54  public IResultHandler ResultHandler { get; }
55 
56  /// <summary>
57  /// Gets the TransactionHandler
58  /// </summary>
59  public ITransactionHandler TransactionHandler { get; }
60 
61  /// <summary>
62  /// Gets the RealTimeHandler
63  /// </summary>
64  public IRealTimeHandler RealTimeHandler { get; }
65 
66  /// <summary>
67  /// Gets the DataCacheProvider
68  /// </summary>
69  public IDataCacheProvider DataCacheProvider { get; }
70 
71  /// <summary>
72  /// The map file provider instance of the algorithm
73  /// </summary>
74  public IMapFileProvider MapFileProvider { get; }
75 
76  /// <summary>
77  /// Creates a new instance
78  /// </summary>
79  /// <param name="universeSelection">The universe selection instance</param>
80  /// <param name="algorithm">Algorithm instance</param>
81  /// <param name="brokerage">New brokerage output instance</param>
82  /// <param name="algorithmNodePacket">Algorithm job task</param>
83  /// <param name="resultHandler">The configured result handler</param>
84  /// <param name="transactionHandler">The configured transaction handler</param>
85  /// <param name="realTimeHandler">The configured real time handler</param>
86  /// <param name="dataCacheProvider">The configured data cache provider</param>
87  /// <param name="mapFileProvider">The map file provider</param>
88  public SetupHandlerParameters(UniverseSelection universeSelection,
89  IAlgorithm algorithm,
90  IBrokerage brokerage,
91  AlgorithmNodePacket algorithmNodePacket,
92  IResultHandler resultHandler,
93  ITransactionHandler transactionHandler,
94  IRealTimeHandler realTimeHandler,
95  IDataCacheProvider dataCacheProvider,
96  IMapFileProvider mapFileProvider
97  )
98  {
99  UniverseSelection = universeSelection;
100  Algorithm = algorithm;
101  Brokerage = brokerage;
102  AlgorithmNodePacket = algorithmNodePacket;
103  ResultHandler = resultHandler;
104  TransactionHandler = transactionHandler;
105  RealTimeHandler = realTimeHandler;
106  DataCacheProvider = dataCacheProvider;
107  MapFileProvider = mapFileProvider;
108  }
109  }
110 }