cosapp.drivers.optionaldriver

Classes

OptionalDriver(name[, owner, force])

Abstract class to be inherited by driver turn off during heavy computation.

class cosapp.drivers.optionaldriver.OptionalDriver(name: str, owner: cosapp.systems.System | None = None, force: bool | None = None, **kwargs)

Bases: Driver

Abstract class to be inherited by driver turn off during heavy computation.

For instance, Driver plotting some information are best turned off during optimization or Monte-Carlo.

error_code: str

is_active() → bool

Is this Module execution activated?

Returns:

Activation status

Return type:

bool

options: OptionsDictionary

classmethod set_inhibited(inhibited: bool) → None

Set the inhibition status for all OptionalDriver classes.

Parameters:

inhibited (bool) – The new inhibition status

start_time: float

status: str