Lean  $LEAN_TAG$
Identity.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 namespace QuantConnect.Indicators
17 {
18  /// <summary>
19  /// Represents an indicator that is a ready after ingesting a single sample and
20  /// always returns the same value as it is given.
21  /// </summary>
22  public class Identity : Indicator, IIndicatorWarmUpPeriodProvider
23  {
24  /// <summary>
25  /// Initializes a new instance of the Identity indicator with the specified name
26  /// </summary>
27  /// <param name="name">The name of the indicator</param>
28  public Identity(string name)
29  : base(name)
30  {
31  }
32 
33  /// <summary>
34  /// Gets a flag indicating when this indicator is ready and fully initialized
35  /// </summary>
36  public override bool IsReady
37  {
38  get { return Samples > 0; }
39  }
40 
41  /// <summary>
42  /// Required period, in data points, for the indicator to be ready and fully initialized
43  /// </summary>
44  public int WarmUpPeriod => 1;
45 
46  /// <summary>
47  /// Computes the next value of this indicator from the given state
48  /// </summary>
49  /// <param name="input">The input given to the indicator</param>
50  /// <returns>A new value for this indicator</returns>
51  protected override decimal ComputeNextValue(IndicatorDataPoint input)
52  {
53  return input.Value;
54  }
55  }
56 }