Files
quantconnect--lean/Common/Expiry.cs
AlexCatarino 5931a42d48 Implements Insight Expiry Helper
Implement a new overload to `Insight` constructor that accepts a  `Func<DateTime, DateTime>` that is used to compute the `CloseTimeUtc` and `Period` after the `Insight` object is emitted (`SetPeriodAndCloseTime` method).

Adds the static Expiry class with functions that can be used to compute a future date/time (expiry) given a date/time.

Closes #3038
2019-04-03 21:46:14 +01:00

67 lines
2.2 KiB
C#

/*
* 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;
namespace QuantConnect
{
/// <summary>
/// Provides static functions that can be used to compute a future <see cref="DateTime"/> (expiry) given a <see cref="DateTime"/>.
/// </summary>
public static class Expiry
{
/// <summary>
/// Computes a date/time one month after a given date/time (nth day to nth day)
/// </summary>
public static Func<DateTime, DateTime> OneMonth => dt => dt.AddMonths(1);
/// <summary>
/// Computes the end of day (mid-night of the next day) of given date/time
/// </summary>
public static Func<DateTime, DateTime> EndOfDay => dt => dt.AddDays(1).Date;
/// <summary>
/// Computes the end of week (next Monday) of given date/time
/// </summary>
public static Func<DateTime, DateTime> EndOfWeek
{
get
{
return dt =>
{
var value = 8 - (int)dt.DayOfWeek;
if (value == 8) value = 1; // Sunday
return dt.AddDays(value).Date;
};
}
}
/// <summary>
/// Computes the end of month (1st of the next month) of given date/time
/// </summary>
public static Func<DateTime, DateTime> EndOfMonth
{
get
{
return dt =>
{
var value = 1 - dt.Day;
return OneMonth(dt).AddDays(value).Date;
};
}
}
}
}