What |
Parameters.xml |
---|---|
Required |
yes |
Description |
Definitions of all parameters used in DELFT-FEWS |
schema location |
http://fews.wldelft.nl/schemas/version1.0/parameters.xsd |
All time series data in DELFT-FEWS must be defined to be of one of the parameters supported. This configuration file defines the list of supported parameters, including the unit of the parameter.
Parameters are organised into ParameterGroups. All parameters within a group should have the same properties and the same units. Only parameters of the same group may be displayed in a single (sub) plot in the time series display, though this can be overruled if requested using a display template.
When available on the file system, the name of the XML file is for example:
Parameters 1.00 default.xml
Parameters Fixed file name for the Parameters configuration
1.00 Version number
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure 25 Root element of the parameter definition
displayUnitConversionId
The unit conversions id to convert from the (internal) units to the display units. This id should be available in the UnitConversionsDescriptors. Only required when a displayUnit is specified for a parameter group
configUnitConversionId
The unit conversions id to convert from the units specified in config files to the internal units for this parameter. This id should be available in the UnitConversionsDescriptors. Only required when a user unit is specified for a thresholdValuesSet, validationRuleSet or ratingCurve
ratingCurveStageParameterId
This parameter is used to resolve the internal stage unit and display stage unit and the name (label) that is used for the rating curve stage axis/column in the user interface
ratingCurveDischargeParameterId
This parameter is used to resolve the internal discharge unit and display discharge unit and the name (label) that is used for the rating curve discharge axis/column in the user interface
parameterGroup
Root element of each definition of a parameter group. Multiple entries may exist.
Attributes;
- id: Id of the parameter group. The ID must be unique.
- name: optional name for the parameter group. Used for reference only.
Figure 26 Elements of the ParameterGroup configuration in the parameter definition
description
Optional description of the parameter group. Used for reference purposes only.
parameterType
Definition if the parameters in the group if these are "instantaneous" parameters or "accumulative" parameter.
dimension
unit
Unit of the parameters defined in the group. The unit may be selected from a list of units supported by DELFT-FEWS. These are generally SI units. For an enumeration of supported units see Appendix B.
displayUnit
Specify when the unit seen by the user is not the same as the unit of the values internally stored in the data store. Also specify displayUnitConversionsId above. In this unit conversions the conversion from (internal) unit to display unit should be available
usesDatum
Indicates if the parameters in the group are to be converted when toggling between local and global datum. Value is either true or false. If the value is true, the elevation defined in the location is added to the time series in the database on conversion.
valueResolution
parameter
Definition of each parameter in a parameter group. Multiple parameters may be defined per group.
Attributes;
- id: Id of the parameter. The ID must be unique.
- name: optional name for the parameter. Used for reference only.
shortName
Short name for the parameter. This name will be used in the time series display and reports.