Lean  $LEAN_TAG$
ConstantSlippageModel.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 QuantConnect.Data;
18 
20 {
21  /// <summary>
22  /// Represents a slippage model that uses a constant percentage of slip
23  /// </summary>
25  {
26  private readonly decimal _slippagePercent;
27  /// <summary>
28  /// Initializes a new instance of the <see cref="ConstantSlippageModel"/> class
29  /// </summary>
30  /// <param name="slippagePercent">The slippage percent for each order. Percent is ranged 0 to 1.</param>
31  public ConstantSlippageModel(decimal slippagePercent)
32  {
33  _slippagePercent = slippagePercent;
34  }
35 
36  /// <summary>
37  /// Slippage Model. Return a decimal cash slippage approximation on the order.
38  /// </summary>
39  public decimal GetSlippageApproximation(Security asset, Order order)
40  {
41  var lastData = asset.GetLastData();
42  if (lastData == null) return 0;
43 
44  return lastData.Value*_slippagePercent;
45  }
46  }
47 }