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

Inheritance diagram for QuantConnect.Scheduling.ScheduleManager:

Public Member Functions
	ScheduleManager (SecurityManager securities, DateTimeZone timeZone, MarketHoursDatabase marketHoursDatabase)
	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,
		MarketHoursDatabase	marketHoursDatabase
	)

Initializes a new instance of the ScheduleManager class

Parameters

securities	Securities manager containing the algorithm's securities
timeZone	The algorithm's time zone
marketHoursDatabase	The market hours database instance to use

Definition at line 53 of file ScheduleManager.cs.

Member Function Documentation

◆ Add()

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

Adds the specified event to the schedule

Parameters

scheduledEvent The event to be scheduled, including the date/times the event fires and the callback

Implements QuantConnect.Scheduling.IEventSchedule.

Definition at line 90 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

scheduledEvent The event to be removed

Implements QuantConnect.Scheduling.IEventSchedule.

Definition at line 109 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

dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
callback	The callback to be invoked

Definition at line 130 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

dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
callback	The callback to be invoked

Definition at line 141 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

dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
callback	The callback to be invoked

Definition at line 152 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

name	The event's unique name
dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
callback	The callback to be invoked

Definition at line 165 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

name	The event's unique name
dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
callback	The callback to be invoked

Definition at line 177 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

name	The event's unique name
dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
callback	The callback to be invoked

Definition at line 189 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 206 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 214 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 226 of file ScheduleManager.cs.

Here is the call 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 234 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

dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
trainingCode	The training code to be invoked

Definition at line 245 of file ScheduleManager.cs.

Here is the call 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

dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
trainingCode	The training code to be invoked

Definition at line 258 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

dateRule	Specifies what dates the event should run
timeRule	Specifies the times on those dates the event should run
trainingCode	The training code to be invoked

Definition at line 270 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:

Common/Scheduling/ScheduleManager.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ScheduleManager()

Member Function Documentation

◆ Add()

◆ Remove()

◆ On() [1/6]

◆ On() [2/6]

◆ On() [3/6]

◆ On() [4/6]

◆ On() [5/6]

◆ On() [6/6]

◆ Event() [1/2]

◆ Event() [2/2]

◆ TrainingNow() [1/2]

◆ TrainingNow() [2/2]

◆ Training() [1/3]

◆ Training() [2/3]

◆ Training() [3/3]

Property Documentation

◆ DateRules

◆ TimeRules