Lean  $LEAN_TAG$
QuantConnect.Scheduling.FuncDateRule Class Reference

Uses a function to define an enumerable of dates over a requested start/end period More...

Inheritance diagram for QuantConnect.Scheduling.FuncDateRule:
[legend]

Public Member Functions

 FuncDateRule (string name, Func< DateTime, DateTime, IEnumerable< DateTime >> getDatesFunction)
 Initializes a new instance of the FuncDateRule class More...
 
IEnumerable< DateTime > GetDates (DateTime start, DateTime end)
 Gets the dates produced by this date rule between the specified times More...
 

Properties

string Name [get]
 Gets a name for this rule More...
 
- Properties inherited from QuantConnect.Scheduling.IDateRule
string Name [get]
 Gets a name for this rule More...
 

Detailed Description

Uses a function to define an enumerable of dates over a requested start/end period

Definition at line 25 of file FuncDateRule.cs.

Constructor & Destructor Documentation

◆ FuncDateRule()

QuantConnect.Scheduling.FuncDateRule.FuncDateRule ( string  name,
Func< DateTime, DateTime, IEnumerable< DateTime >>  getDatesFunction 
)

Initializes a new instance of the FuncDateRule class

Parameters
nameThe name of this rule
getDatesFunctionThe time applicator function

Definition at line 34 of file FuncDateRule.cs.

Member Function Documentation

◆ GetDates()

IEnumerable<DateTime> QuantConnect.Scheduling.FuncDateRule.GetDates ( DateTime  start,
DateTime  end 
)

Gets the dates produced by this date rule between the specified times

Parameters
startThe start of the interval to produce dates for
endThe end of the interval to produce dates for
Returns
All dates in the interval matching this date rule

Implements QuantConnect.Scheduling.IDateRule.

Definition at line 54 of file FuncDateRule.cs.

Property Documentation

◆ Name

string QuantConnect.Scheduling.FuncDateRule.Name
get

Gets a name for this rule

Definition at line 44 of file FuncDateRule.cs.


The documentation for this class was generated from the following file: