QuantConnect.IIsolatorLimitResultProvider Interface Reference

Provides an abstraction for managing isolator limit results. This is originally intended to be used by the training feature to permit a single algorithm time loop to extend past the default of ten minutes More...

Inheritance diagram for QuantConnect.IIsolatorLimitResultProvider:

Public Member Functions
IsolatorLimitResult	IsWithinLimit ()
	Determines whether or not a custom isolator limit has be reached. More...
void	RequestAdditionalTime (int minutes)
	Requests additional time from the isolator result provider. This is intended to prevent IsWithinLimit from returning an error result. This method will throw a TimeoutException if there is insufficient resources available to fulfill the specified number of minutes. More...
bool	TryRequestAdditionalTime (int minutes)
	Attempts to request additional time from the isolator result provider. This is intended to prevent IsWithinLimit from returning an error result. This method will only return false if there is insufficient resources available to fulfill the specified number of minutes. More...

Detailed Description

Provides an abstraction for managing isolator limit results. This is originally intended to be used by the training feature to permit a single algorithm time loop to extend past the default of ten minutes

Definition at line 25 of file IIsolatorLimitResultProvider.cs.

Member Function Documentation

IsWithinLimit()

IsolatorLimitResult QuantConnect.IIsolatorLimitResultProvider.IsWithinLimit

(

)

Determines whether or not a custom isolator limit has be reached.

Implemented in QuantConnect.Lean.Engine.AlgorithmTimeLimitManager.

RequestAdditionalTime()

void QuantConnect.IIsolatorLimitResultProvider.RequestAdditionalTime

(

int

minutes

)

Requests additional time from the isolator result provider. This is intended to prevent IsWithinLimit from returning an error result. This method will throw a TimeoutException if there is insufficient resources available to fulfill the specified number of minutes.

Parameters

minutes

The number of additional minutes to request

Implemented in QuantConnect.Lean.Engine.AlgorithmTimeLimitManager.

Here is the caller graph for this function:

TryRequestAdditionalTime()

bool QuantConnect.IIsolatorLimitResultProvider.TryRequestAdditionalTime

(

int

minutes

)

Attempts to request additional time from the isolator result provider. This is intended to prevent IsWithinLimit from returning an error result. This method will only return false if there is insufficient resources available to fulfill the specified number of minutes.

Parameters

minutes

The number of additional minutes to request

Implemented in QuantConnect.Lean.Engine.AlgorithmTimeLimitManager.

---

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

• Common/IIsolatorLimitResultProvider.cs