Lean  $LEAN_TAG$
QuantConnect.Scheduling.CompositeTimeRule Class Reference

Combines multiple time rules into a single rule that emits for each rule More...

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

Public Member Functions

 CompositeTimeRule (params ITimeRule[] timeRules)
 Initializes a new instance of the CompositeTimeRule class More...
 
 CompositeTimeRule (IEnumerable< ITimeRule > timeRules)
 Initializes a new instance of the CompositeTimeRule class More...
 
IEnumerable< DateTime > CreateUtcEventTimes (IEnumerable< DateTime > dates)
 Creates the event times for the specified dates in UTC More...
 

Public Attributes

readonly IReadOnlyList< ITimeRuleRules
 Gets the individual rules for this composite rule More...
 

Properties

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

Detailed Description

Combines multiple time rules into a single rule that emits for each rule

Definition at line 27 of file CompositeTimeRule.cs.

Constructor & Destructor Documentation

◆ CompositeTimeRule() [1/2]

QuantConnect.Scheduling.CompositeTimeRule.CompositeTimeRule ( params ITimeRule[]  timeRules)

Initializes a new instance of the CompositeTimeRule class

Parameters
timeRulesThe time rules to compose

Definition at line 38 of file CompositeTimeRule.cs.

◆ CompositeTimeRule() [2/2]

QuantConnect.Scheduling.CompositeTimeRule.CompositeTimeRule ( IEnumerable< ITimeRule timeRules)

Initializes a new instance of the CompositeTimeRule class

Parameters
timeRulesThe time rules to compose

Definition at line 47 of file CompositeTimeRule.cs.

Member Function Documentation

◆ CreateUtcEventTimes()

IEnumerable<DateTime> QuantConnect.Scheduling.CompositeTimeRule.CreateUtcEventTimes ( IEnumerable< DateTime >  dates)

Creates the event times for the specified dates in UTC

Parameters
datesThe dates to apply times to
Returns
An enumerable of date times that is the result of applying this rule to the specified dates

Implements QuantConnect.Scheduling.ITimeRule.

Definition at line 66 of file CompositeTimeRule.cs.

Member Data Documentation

◆ Rules

readonly IReadOnlyList<ITimeRule> QuantConnect.Scheduling.CompositeTimeRule.Rules

Gets the individual rules for this composite rule

Definition at line 32 of file CompositeTimeRule.cs.

Property Documentation

◆ Name

string QuantConnect.Scheduling.CompositeTimeRule.Name
get

Gets a name for this rule

Definition at line 56 of file CompositeTimeRule.cs.


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