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='')[source]¶ Bases:
object
Data class to represent a single parameter’s metadata
Parameters: -
name
¶ str
-
description
¶ str
-
absolute_range
¶ tuple
-
suggested_range
¶ tuple
-
default_value
¶ float or int
-
units
¶ str
-
classmethod
from_dict
(data)[source]¶ 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': '%' }
-
-
class
smif.parameters.parameters.
ParameterList
(parameters=None)[source]¶ Bases:
collections.abc.Mapping
Collection of parameters
Parameters: parameters (list of smif.parameter.Parameter, optional) – -
add_parameter
(parameter)[source]¶ Add a parameter
Parameters: parameter (smif.parameter.Parameter or dict) –
-
names
¶ Returns the names of all the contained parameters
-
defaults
¶ Default parameter values
-