smif.parameters.parameters module

Parameter and ParameterList

Summary

Classes:

Parameter	Data class to represent a single parameter’s metadata
ParameterList	Collection of parameters

Reference

class smif.parameters.parameters.Parameter(name='', description='', absolute_range=(0, 0), suggested_range=(0, 0), default_value=0, units='')

Bases: object

Data class to represent a single parameter’s metadata

Parameters:

• name (str, optional) –
• description (str, optional) –
• absolute_range (tuple, optional) –
• suggested_range (tuple, optional) –
• default_value (float or int, optional) –
• units (str, optional) –

name

str

description

str

absolute_range

tuple

suggested_range

tuple

default_value

float or int

units

str

classmethod from_dict(data)

Create a Parameter from a dictionary of values

Parameters:data (dict) –

Dictionary with values for each attribute, like:

{
    'name': 'smart_meter_savings',
    'description': 'The savings from smart meters',
    'absolute_range': (0, 100),
    'suggested_range': (3, 10),
    'default_value': 3,
    'units': '%'
}

as_dict()

Return a dict of parameter data

class smif.parameters.parameters.ParameterList(parameters=None)

Bases: collections.abc.Mapping

Collection of parameters

Parameters:parameters (list of smif.parameter.Parameter, optional) –

add_parameter(parameter)

Add a parameter

Parameters:parameter (smif.parameter.Parameter or dict) –

as_list()

Return a list of dicts of parameter data

names

Returns the names of all the contained parameters

defaults

Default parameter values

overridden(new_values)

Override parameter values, falling back to defaults

Parameters:new_values (dict) – Dict with keys matching parameter names, values to override the defaults