Lean  $LEAN_TAG$
QuantConnect.Scheduling.TimeMonitor Class Reference

Helper class that will monitor timer consumers and request more time if required. Used by IsolatorLimitResultProvider More...

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

Public Member Functions

 TimeMonitor (int monitorIntervalMs=100)
 Creates a new instance More...
 
void Add (TimeConsumer consumer)
 Adds a new time consumer element to be monitored More...
 
void Dispose ()
 Disposes of the inner timer More...
 

Protected Member Functions

virtual void ProcessConsumer (TimeConsumer consumer)
 Process the TimeConsumer object in TimeConsumers list More...
 
virtual void RemoveAll ()
 Remove all TimeConsumer objects where the Finished field is marked as true More...
 

Properties

List< TimeConsumerTimeConsumers [get]
 List to store the coming TimeConsumer objects More...
 
int Count [get]
 Returns the number of time consumers currently being monitored More...
 

Detailed Description

Helper class that will monitor timer consumers and request more time if required. Used by IsolatorLimitResultProvider

Definition at line 27 of file TimeMonitor.cs.

Constructor & Destructor Documentation

◆ TimeMonitor()

QuantConnect.Scheduling.TimeMonitor.TimeMonitor ( int  monitorIntervalMs = 100)

Creates a new instance

Definition at line 54 of file TimeMonitor.cs.

Here is the call graph for this function:

Member Function Documentation

◆ ProcessConsumer()

virtual void QuantConnect.Scheduling.TimeMonitor.ProcessConsumer ( TimeConsumer  consumer)
protectedvirtual

Process the TimeConsumer object in TimeConsumers list

Parameters
consumerThe TimeConsumer object to be processed

This method is protected because it's overrode by a test class in IsolatorLimitResultProviderTests.cs

Definition at line 91 of file TimeMonitor.cs.

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

◆ RemoveAll()

virtual void QuantConnect.Scheduling.TimeMonitor.RemoveAll ( )
protectedvirtual

Remove all TimeConsumer objects where the Finished field is marked as true

This method is protected because it's overrode by a test class in IsolatorLimitResultProviderTests.cs

Definition at line 119 of file TimeMonitor.cs.

Here is the caller graph for this function:

◆ Add()

void QuantConnect.Scheduling.TimeMonitor.Add ( TimeConsumer  consumer)

Adds a new time consumer element to be monitored

Parameters
consumerTime consumer instance

Definition at line 128 of file TimeMonitor.cs.

Here is the caller graph for this function:

◆ Dispose()

void QuantConnect.Scheduling.TimeMonitor.Dispose ( )

Disposes of the inner timer

Definition at line 139 of file TimeMonitor.cs.

Property Documentation

◆ TimeConsumers

List<TimeConsumer> QuantConnect.Scheduling.TimeMonitor.TimeConsumers
getprotected

List to store the coming TimeConsumer objects

This field is protected because it's used in a test class in `IsolatorLimitResultProviderTests.cs

Definition at line 35 of file TimeMonitor.cs.

◆ Count

int QuantConnect.Scheduling.TimeMonitor.Count
get

Returns the number of time consumers currently being monitored

Definition at line 41 of file TimeMonitor.cs.


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