﻿/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/

using System;
using QuantConnect.Data;

package com.quantconnect.lean.Indicators
{
    /**
     * An indicator that will always return the same value.
    */
     * <typeparam name="T The type of input this indicator takes</typeparam>
    public sealed class ConstantIndicator<T> : IndicatorBase<T>
        where T : BaseData
    {
        private final BigDecimal _value;

        /**
         * Gets true since the ConstantIndicator is always ready to return the same value
        */
        public @Override boolean IsReady
        {
            get { return true; }
        }

        /**
         * Creates a new ConstantIndicator that will always return the specified value
        */
         * @param name The name of this indicator
         * @param value The constant value to be returned
        public ConstantIndicator( String name, BigDecimal value)
            : base(name) {
            _value = value;

            // set this immediatelyso it always has the .Value property correctly set, the
            // time will be updated anytime this indicators Update method gets called.
            Current = new IndicatorDataPoint(DateTime.MinValue, value);
        }

        /**
         * Computes the next value of this indicator from the given state
        */
         * @param input The input given to the indicator
        @returns A new value for this indicator
        protected @Override BigDecimal ComputeNextValue(T input) {
            return _value;
        }

        /**
         * Resets this indicator to its initial state
        */
        public @Override void Reset() {
            base.Reset();

            // re-initialize the current value, constant should ALWAYS return this value
            Current = new IndicatorDataPoint(DateTime.MinValue, _value);
        }
    }
}