pywr.parameters.MultipleThresholdParameterIndexParameter

class pywr.parameters.MultipleThresholdParameterIndexParameter(model, parameter, thresholds, use_max_flow=False, **kwargs)

Return an index based on the value in the parameter against multiple given thresholds.

Parameters
parameterParameter
thresholdsiterable of Parameter instances or floats
__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

after(self)

before(self)

finish(self)

get_all_indices(self)

get_all_values(self)

get_constant_value(self)

Return a constant value.

get_double_lower_bounds(self)

get_double_upper_bounds(self)

get_double_variables(self)

get_index(self, ScenarioIndex scenario_index)

get_integer_lower_bounds(self)

get_integer_upper_bounds(self)

get_integer_variables(self)

get_value(self, ScenarioIndex scenario_index)

index(self, Timestep timestep, ...)

Returns the index of the first threshold the parameter value is above.

load(type cls, model, data)

register(type cls)

reset(self)

set_double_variables(self, double[)

set_integer_variables(self, int[)

setup(self)

unregister(type cls)

value(self, Timestep timestep, ...)

Returns the current index as a float

Attributes

children

comment

comment: unicode

double_size

double_size: 'int'

integer_size

integer_size: 'int'

is_constant

is_variable

is_variable: 'bool'

model

name

parameter

parameter: pywr.parameters._parameters.Parameter

parents

size

tags

tags: dict