Lean  $LEAN_TAG$
QuantConnect.Scheduling.ScheduleManager Class Reference

Provides access to the real time handler's event scheduling feature More...

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

Public Member Functions

 ScheduleManager (SecurityManager securities, DateTimeZone timeZone)
 Initializes a new instance of the ScheduleManager class More...
 
void Add (ScheduledEvent scheduledEvent)
 Adds the specified event to the schedule More...
 
void Remove (ScheduledEvent scheduledEvent)
 Removes the specified event from the schedule More...
 
ScheduledEvent On (IDateRule dateRule, ITimeRule timeRule, Action callback)
 Schedules the callback to run using the specified date and time rules More...
 
ScheduledEvent On (IDateRule dateRule, ITimeRule timeRule, PyObject callback)
 Schedules the callback to run using the specified date and time rules More...
 
ScheduledEvent On (IDateRule dateRule, ITimeRule timeRule, Action< string, DateTime > callback)
 Schedules the callback to run using the specified date and time rules More...
 
ScheduledEvent On (string name, IDateRule dateRule, ITimeRule timeRule, Action callback)
 Schedules the callback to run using the specified date and time rules More...
 
ScheduledEvent On (string name, IDateRule dateRule, ITimeRule timeRule, PyObject callback)
 Schedules the callback to run using the specified date and time rules More...
 
ScheduledEvent On (string name, IDateRule dateRule, ITimeRule timeRule, Action< string, DateTime > callback)
 Schedules the callback to run using the specified date and time rules More...
 
IFluentSchedulingDateSpecifier Event ()
 Entry point for the fluent scheduled event builder More...
 
IFluentSchedulingDateSpecifier Event (string name)
 Entry point for the fluent scheduled event builder More...
 
ScheduledEvent TrainingNow (Action trainingCode)
 Schedules the provided training code to execute immediately More...
 
ScheduledEvent TrainingNow (PyObject trainingCode)
 Schedules the provided training code to execute immediately More...
 
ScheduledEvent Training (IDateRule dateRule, ITimeRule timeRule, Action trainingCode)
 Schedules the training code to run using the specified date and time rules More...
 
ScheduledEvent Training (IDateRule dateRule, ITimeRule timeRule, PyObject trainingCode)
 Schedules the training code to run using the specified date and time rules More...
 
ScheduledEvent Training (IDateRule dateRule, ITimeRule timeRule, Action< DateTime > trainingCode)
 Schedules the training code to run using the specified date and time rules More...
 

Properties

DateRules DateRules [get]
 Gets the date rules helper object to make specifying dates for events easier More...
 
TimeRules TimeRules [get]
 Gets the time rules helper object to make specifying times for events easier More...
 

Detailed Description

Provides access to the real time handler's event scheduling feature

Definition at line 29 of file ScheduleManager.cs.

Constructor & Destructor Documentation

◆ ScheduleManager()

QuantConnect.Scheduling.ScheduleManager.ScheduleManager ( SecurityManager  securities,
DateTimeZone  timeZone 
)

Initializes a new instance of the ScheduleManager class

Parameters
securitiesSecurities manager containing the algorithm's securities
timeZoneThe algorithm's time zone

Definition at line 52 of file ScheduleManager.cs.

Member Function Documentation

◆ Add()

void QuantConnect.Scheduling.ScheduleManager.Add ( ScheduledEvent  scheduledEvent)

Adds the specified event to the schedule

Parameters
scheduledEventThe event to be scheduled, including the date/times the event fires and the callback

Implements QuantConnect.Scheduling.IEventSchedule.

Definition at line 89 of file ScheduleManager.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Remove()

void QuantConnect.Scheduling.ScheduleManager.Remove ( ScheduledEvent  scheduledEvent)

Removes the specified event from the schedule

Parameters
scheduledEventThe event to be removed

Implements QuantConnect.Scheduling.IEventSchedule.

Definition at line 108 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ On() [1/6]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.On ( IDateRule  dateRule,
ITimeRule  timeRule,
Action  callback 
)

Schedules the callback to run using the specified date and time rules

Parameters
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
callbackThe callback to be invoked

Definition at line 129 of file ScheduleManager.cs.

Here is the caller graph for this function:

◆ On() [2/6]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.On ( IDateRule  dateRule,
ITimeRule  timeRule,
PyObject  callback 
)

Schedules the callback to run using the specified date and time rules

Parameters
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
callbackThe callback to be invoked

Definition at line 140 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ On() [3/6]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.On ( IDateRule  dateRule,
ITimeRule  timeRule,
Action< string, DateTime >  callback 
)

Schedules the callback to run using the specified date and time rules

Parameters
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
callbackThe callback to be invoked

Definition at line 151 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ On() [4/6]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.On ( string  name,
IDateRule  dateRule,
ITimeRule  timeRule,
Action  callback 
)

Schedules the callback to run using the specified date and time rules

Parameters
nameThe event's unique name
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
callbackThe callback to be invoked

Definition at line 164 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ On() [5/6]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.On ( string  name,
IDateRule  dateRule,
ITimeRule  timeRule,
PyObject  callback 
)

Schedules the callback to run using the specified date and time rules

Parameters
nameThe event's unique name
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
callbackThe callback to be invoked

Definition at line 176 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ On() [6/6]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.On ( string  name,
IDateRule  dateRule,
ITimeRule  timeRule,
Action< string, DateTime >  callback 
)

Schedules the callback to run using the specified date and time rules

Parameters
nameThe event's unique name
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
callbackThe callback to be invoked

Definition at line 188 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ Event() [1/2]

IFluentSchedulingDateSpecifier QuantConnect.Scheduling.ScheduleManager.Event ( )

Entry point for the fluent scheduled event builder

Definition at line 205 of file ScheduleManager.cs.

◆ Event() [2/2]

IFluentSchedulingDateSpecifier QuantConnect.Scheduling.ScheduleManager.Event ( string  name)

Entry point for the fluent scheduled event builder

Definition at line 213 of file ScheduleManager.cs.

◆ TrainingNow() [1/2]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.TrainingNow ( Action  trainingCode)

Schedules the provided training code to execute immediately

Definition at line 225 of file ScheduleManager.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TrainingNow() [2/2]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.TrainingNow ( PyObject  trainingCode)

Schedules the provided training code to execute immediately

Definition at line 233 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ Training() [1/3]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.Training ( IDateRule  dateRule,
ITimeRule  timeRule,
Action  trainingCode 
)

Schedules the training code to run using the specified date and time rules

Parameters
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
trainingCodeThe training code to be invoked

Definition at line 244 of file ScheduleManager.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Training() [2/3]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.Training ( IDateRule  dateRule,
ITimeRule  timeRule,
PyObject  trainingCode 
)

Schedules the training code to run using the specified date and time rules

Parameters
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
trainingCodeThe training code to be invoked

Definition at line 257 of file ScheduleManager.cs.

Here is the call graph for this function:

◆ Training() [3/3]

ScheduledEvent QuantConnect.Scheduling.ScheduleManager.Training ( IDateRule  dateRule,
ITimeRule  timeRule,
Action< DateTime >  trainingCode 
)

Schedules the training code to run using the specified date and time rules

Parameters
dateRuleSpecifies what dates the event should run
timeRuleSpecifies the times on those dates the event should run
trainingCodeThe training code to be invoked

Definition at line 269 of file ScheduleManager.cs.

Here is the call graph for this function:

Property Documentation

◆ DateRules

DateRules QuantConnect.Scheduling.ScheduleManager.DateRules
get

Gets the date rules helper object to make specifying dates for events easier

Definition at line 40 of file ScheduleManager.cs.

◆ TimeRules

TimeRules QuantConnect.Scheduling.ScheduleManager.TimeRules
get

Gets the time rules helper object to make specifying times for events easier

Definition at line 45 of file ScheduleManager.cs.


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