Indexed Array Parameter

General Description

Parameter which uses an IndexParameter to index an array of Parameters.

An example use of this parameter is to return a demand saving factor (as a float) based on the current demand saving level (calculated by an IndexParameter). API Reference

Attributes

Name
Description
Required

index_parameter

IndexParameter

Yes

params

iterable of Parameters or floats

Yes

Example

{
	"type": "indexedarrayparameter",
	"index_parameter": "Reservoir control curve",
	"params": [
		1,
		0.9,
		0.8,
		0.5
	]
}

The above code uses the Index supplied by the parameter called 'Reservoir control curve', which is a Control Curve Index Parameter. Index 0 returns a 1, Index 2 returns 0.9 etc...

In this example this parameter is used to reduce a demand based on a reservoir control curve. Please go to the Aggregated Parameter example to see how this is done.

Please see how the Reservoir control curve parameter is defined.

Last updated

Was this helpful?