TimePar

class TimePar(v=None, *args, **kwargs)

Bases: BaseArr

Base class for time-aware parameters, durations and rates

NB, because the factor needs to be recalculated, do not set values directly.

Attributes

isarray

Check if the value is an array

Methods

validate_units()

Check that the units entered are valid

init(parent=None, parent_unit=None, parent_dt=None, update_values=True, die=True)

Link to the sim and/or module units

property isarray

Check if the value is an array

set(v=None, unit=None, parent_unit=None, parent_dt=None, self_dt=None, force=False)

Set the specified parameter values (ignoring None values) and update stored values

update_cached(update_values=True, die=True)

Update the cached factor and values

update_factor()

Set factor used to multiply the value to get the output

update_values()

Convert from self.v to self.values based on self.factor – must be implemented by derived classes

to(unit=None, dt=None)

Create a new timepar based on the current one but with a different unit and/or dt

to_parent()

Create a new timepar with the same units as the parent

to_json()

Export to JSON