quantconnect--lean/Common/Data/HistoryRequest.cs

/*
 * 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 NodaTime;
using QuantConnect.Securities;
using System.Collections.Generic;
using QuantConnect.Util;

namespace QuantConnect.Data
{
    /// <summary>
    /// Represents a request for historical data
    /// </summary>
    public class HistoryRequest : BaseDataRequest
    {
        private Resolution? _fillForwardResolution;
        private bool _includeExtendedMarketHours;

        /// <summary>
        /// Gets the symbol to request data for
        /// </summary>
        public Symbol Symbol { get; set; }

        /// <summary>
        /// Gets the requested data resolution
        /// </summary>
        public Resolution Resolution { get; set; }

        /// <summary>
        /// Gets the requested fill forward resolution, set to null for no fill forward behavior.
        /// Will always return null when Resolution is set to Tick.
        /// </summary>
        public Resolution? FillForwardResolution
        {
            get
            {
                return Resolution == Resolution.Tick ? null : _fillForwardResolution;
            }
            set
            {
                _fillForwardResolution = value;
            }
        }

        /// <summary>
        /// Gets whether or not to include extended market hours data, set to false for only normal market hours
        /// </summary>
        public bool IncludeExtendedMarketHours
        {
            get
            {
                return _includeExtendedMarketHours;
            }
            set
            {
                _includeExtendedMarketHours = value && LeanData.SupportsExtendedMarketHours(DataType);
            }
        }

        /// <summary>
        /// Gets the time zone of the time stamps on the raw input data
        /// </summary>
        public DateTimeZone DataTimeZone { get; set; }

        /// <summary>
        /// TickType of the history request
        /// </summary>
        public TickType TickType { get; set; }

        /// <summary>
        /// Gets the normalization mode used for this subscription
        /// </summary>
        public DataNormalizationMode DataNormalizationMode { get; set; }

        /// <summary>
        /// Gets the data mapping mode used for this subscription
        /// </summary>
        public DataMappingMode DataMappingMode { get; set; }

        /// <summary>
        /// The continuous contract desired offset from the current front month.
        /// For example, 0 (default) will use the front month, 1 will use the back month contract
        /// </summary>
        public uint ContractDepthOffset { get; set; }

        /// <summary>
        /// Gets the tradable days specified by this request, in the security's data time zone
        /// </summary>
        public override IEnumerable<DateTime> TradableDaysInDataTimeZone => Time.EachTradeableDayInTimeZone(ExchangeHours,
            StartTimeLocal,
            EndTimeLocal,
            DataTimeZone,
            IncludeExtendedMarketHours);

        /// <summary>
        /// Initializes a new instance of the <see cref="HistoryRequest"/> class from the specified parameters
        /// </summary>
        /// <param name="startTimeUtc">The start time for this request,</param>
        /// <param name="endTimeUtc">The end time for this request</param>
        /// <param name="dataType">The data type of the output data</param>
        /// <param name="symbol">The symbol to request data for</param>
        /// <param name="resolution">The requested data resolution</param>
        /// <param name="exchangeHours">The exchange hours used in fill forward processing</param>
        /// <param name="dataTimeZone">The time zone of the data</param>
        /// <param name="fillForwardResolution">The requested fill forward resolution for this request</param>
        /// <param name="includeExtendedMarketHours">True to include data from pre/post market hours</param>
        /// <param name="isCustomData">True for custom user data, false for normal QC data</param>
        /// <param name="dataNormalizationMode">Specifies normalization mode used for this subscription</param>
        /// <param name="tickType">The tick type used to created the <see cref="SubscriptionDataConfig"/> for the retrieval of history data</param>
        /// <param name="dataMappingMode">The contract mapping mode to use for the security</param>
        /// <param name="contractDepthOffset">The continuous contract desired offset from the current front month.
        /// For example, 0 will use the front month, 1 will use the back month contract</param>
        public HistoryRequest(DateTime startTimeUtc,
            DateTime endTimeUtc,
            Type dataType,
            Symbol symbol,
            Resolution resolution,
            SecurityExchangeHours exchangeHours,
            DateTimeZone dataTimeZone,
            Resolution? fillForwardResolution,
            bool includeExtendedMarketHours,
            bool isCustomData,
            DataNormalizationMode dataNormalizationMode,
            TickType tickType,
            DataMappingMode dataMappingMode = DataMappingMode.OpenInterest,
            uint contractDepthOffset = 0)
            : base(startTimeUtc, endTimeUtc, exchangeHours, tickType, isCustomData, dataType)
        {
            Symbol = symbol;
            DataTimeZone = dataTimeZone;
            Resolution = resolution;
            FillForwardResolution = fillForwardResolution;
            IncludeExtendedMarketHours = includeExtendedMarketHours;
            DataNormalizationMode = dataNormalizationMode;
            TickType = tickType;
            DataMappingMode = dataMappingMode;
            ContractDepthOffset = contractDepthOffset;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="HistoryRequest"/> class from the specified config and exchange hours
        /// </summary>
        /// <param name="config">The subscription data config used to initialize this request</param>
        /// <param name="hours">The exchange hours used for fill forward processing</param>
        /// <param name="startTimeUtc">The start time for this request,</param>
        /// <param name="endTimeUtc">The end time for this request</param>
        public HistoryRequest(SubscriptionDataConfig config, SecurityExchangeHours hours, DateTime startTimeUtc, DateTime endTimeUtc)
            : this(startTimeUtc, endTimeUtc, config.Type, config.Symbol, config.Resolution,
                hours, config.DataTimeZone, config.FillDataForward ? config.Resolution : (Resolution?)null,
                config.ExtendedMarketHours, config.IsCustomData, config.DataNormalizationMode, config.TickType, config.DataMappingMode, config.ContractDepthOffset)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="HistoryRequest"/> class with new Symbol, StartTimeUtc, EndTimeUtc
        /// </summary>
        /// <param name="request">Represents a request for historical data</param>
        /// <param name="newStartTimeUtc">The start time for this request</param>
        /// <param name="newEndTimeUtc">The end time for this request</param>
        public HistoryRequest(HistoryRequest request, Symbol newSymbol, DateTime newStartTimeUtc, DateTime newEndTimeUtc)
            : this (newStartTimeUtc, newEndTimeUtc, request.DataType, newSymbol, request.Resolution, request.ExchangeHours, request.DataTimeZone, request.FillForwardResolution,
                  request.IncludeExtendedMarketHours, request.IsCustomData, request.DataNormalizationMode, request.TickType, request.DataMappingMode, request.ContractDepthOffset)
        { }
    }
}