Field | Type | Description |
---|---|---|
parameter_X | struct with the fields described in the table below |
parameter_X with X being an integer is a parameter that the user can arbitrarily define. For "temperature" to be defined as a parameter, only the following fields should be provided:
|
Each struct above consists of the following fields:
Field | Type | Description |
---|---|---|
name |
string |
Name of the parameter. |
category |
string |
The name of the category that the parameter will be within the property view of INTERCONNECT. |
kind | string |
The type of quantity described by this parameter. The values for this parameter correspond to the allowed values within the "Kind" dropdown menu within the Property Editor in INTERCONNECT. The "Kind" determines the units. Some example kinds are:
|
type | string |
A string with the type of value allowed by this parameter. The options are given by the "Type" dropdown menu within the Property Editor in INTERCONNECT. Some examples:
|
unit |
string |
The unit of the parameter. This should be a valid unit with respect to the parameter kind set in the "kind" field. Some example units are:
|
default |
number |
The nominal value of the parameter |
visible_to_user |
boolean |
A flag to enable/disable the parameter in the model. |
annotate |
boolean | A flag to annotate the parameter value if the visible_to_user is set to True. |
min
|
number |
Minimum allowed value if the visible_to_user as well is set to True. |
max
|
number |
Maximum allowed value if the visible_to_user as well is set to True. |