IsolatorLimitResult
IsolatorLimitResult(
current_time_step_elapsed: timedelta, error_message: str
)
Bases: Object
Represents the result of the Isolator limiter callback
Initializes a new instance of the IsolatorLimitResult class
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
current_time_step_elapsed
|
timedelta
|
The amount of time spent on the current time step |
required |
error_message
|
str
|
The error message or an empty string if no error on the current time step |
required |
current_time_step_elapsed: timedelta
Gets the amount of time spent on the current time step
error_message: str
Gets the error message or an empty string if no error on the current time step
is_within_custom_limits: bool
Returns true if there are no errors in the current time step