/*
* 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.Market;
using Python.Runtime;
namespace QuantConnect.Data.Consolidators
{
///
/// Consolidates ticks into quote bars. This consolidator ignores trade ticks
///
public class TickQuoteBarConsolidator : PeriodCountConsolidatorBase
{
///
/// Initializes a new instance of the class
///
/// The minimum span of time before emitting a consolidated bar
public TickQuoteBarConsolidator(TimeSpan period)
: base(period)
{
}
///
/// Initializes a new instance of the class
///
/// The number of pieces to accept before emitting a consolidated bar
public TickQuoteBarConsolidator(int maxCount)
: base(maxCount)
{
}
///
/// Initializes a new instance of the class
///
/// The number of pieces to accept before emitting a consolidated bar
/// The minimum span of time before emitting a consolidated bar
public TickQuoteBarConsolidator(int maxCount, TimeSpan period)
: base(maxCount, period)
{
}
///
/// Initializes a new instance of the class
///
/// Func that defines the start time of a consolidated data
public TickQuoteBarConsolidator(Func func)
: base(func)
{
}
///
/// Initializes a new instance of the class
///
/// Python function object that defines the start time of a consolidated data
public TickQuoteBarConsolidator(PyObject pyfuncobj)
: base(pyfuncobj)
{
}
///
/// Determines whether or not the specified data should be processed
///
/// The data to check
/// True if the consolidator should process this data, false otherwise
protected override bool ShouldProcess(Tick data)
{
return data.TickType == TickType.Quote;
}
///
/// Aggregates the new 'data' into the 'workingBar'. The 'workingBar' will be
/// null following the event firing
///
/// The bar we're building, null if the event was just fired and we're starting a new consolidated bar
/// The new data
protected override void AggregateBar(ref QuoteBar workingBar, Tick data)
{
if (workingBar == null)
{
workingBar = new QuoteBar(GetRoundedBarTime(data), data.Symbol, null, decimal.Zero, null, decimal.Zero, Period);
// open ask and bid should match previous close ask and bid
if (Consolidated != null)
{
// note that we will only fill forward previous close ask and bid when a new data point comes in and we generate a new working bar which is not a fill forward bar
var previous = Consolidated as QuoteBar;
workingBar.Update(decimal.Zero, previous.Bid?.Close ?? decimal.Zero, previous.Ask?.Close ?? decimal.Zero, decimal.Zero, previous.LastBidSize, previous.LastAskSize);
}
}
// update the bid and ask
workingBar.Update(decimal.Zero, data.BidPrice, data.AskPrice, decimal.Zero, data.BidSize, data.AskSize);
if (!Period.HasValue) workingBar.EndTime = GetRoundedBarTime(data.EndTime);
}
}
}