Lean  $LEAN_TAG$
QuantConnect.IsolatorLimitResult Class Reference

Represents the result of the Isolator limiter callback More...

Public Member Functions

 IsolatorLimitResult (TimeSpan currentTimeStepElapsed, string errorMessage)
 Initializes a new instance of the IsolatorLimitResult class More...
 

Public Attributes

bool IsWithinCustomLimits => string.IsNullOrEmpty(ErrorMessage)
 Returns true if there are no errors in the current time step More...
 

Properties

TimeSpan CurrentTimeStepElapsed [get]
 Gets the amount of time spent on the current time step More...
 
string ErrorMessage [get]
 Gets the error message or an empty string if no error on the current time step More...
 

Detailed Description

Represents the result of the Isolator limiter callback

Definition at line 23 of file IsolatorLimitResult.cs.

Constructor & Destructor Documentation

◆ IsolatorLimitResult()

QuantConnect.IsolatorLimitResult.IsolatorLimitResult ( TimeSpan  currentTimeStepElapsed,
string  errorMessage 
)

Initializes a new instance of the IsolatorLimitResult class

Parameters
currentTimeStepElapsedThe amount of time spent on the current time step
errorMessageThe error message or an empty string if no error on the current time step

Definition at line 45 of file IsolatorLimitResult.cs.

Member Data Documentation

◆ IsWithinCustomLimits

bool QuantConnect.IsolatorLimitResult.IsWithinCustomLimits => string.IsNullOrEmpty(ErrorMessage)

Returns true if there are no errors in the current time step

Definition at line 38 of file IsolatorLimitResult.cs.

Property Documentation

◆ CurrentTimeStepElapsed

TimeSpan QuantConnect.IsolatorLimitResult.CurrentTimeStepElapsed
get

Gets the amount of time spent on the current time step

Definition at line 28 of file IsolatorLimitResult.cs.

◆ ErrorMessage

string QuantConnect.IsolatorLimitResult.ErrorMessage
get

Gets the error message or an empty string if no error on the current time step

Definition at line 33 of file IsolatorLimitResult.cs.


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