...
What | locationSets.xml |
---|---|
Required | no |
Description | Definitions of groups of locations |
schema location |
Contents
Table of Contents | ||
---|---|---|
|
Overview
Location sets may be used to define logical groups of locations. Often an action may need to be taken on a whole set of locations (e.g. validation). By creating a LocationSet the action need only be defined once on a location set and not on individual locations. Any location may appear in more than one location set. Internally a location set is simply evaluated as a list of locations.
The location set configuration file is included in the RegionConfigFiles\ folder: LocationSets.xml
...
Shape file, GeoJSON file and CSV file
It is possible to define locationSets with locations that are automatically generated (so NOT defined in the locations.xml) from an ESRI Shape (dbf) file, geoJSON file or from a CSV table. See all detailed information at the the next page
Database Table
It is also possible to define locationSets with locations that are read directly from a database. The contents of the database table are on the fly read and converted to a DBZ file. This DBZ file will be used by FEWS. This is for backup purpose in case the database is not available any more, like in stand-alone test environments. See all detailed information at the next page
LocationSet XML file elements
locationSet
Root element for the definition of a location set. Multiple entries may exist. The Id of the location set must be unique.
...
Optional element available since 2018.01. By default this element is set to true and FEWS will log a debug message when an empty locationSet is created. If set to false, FEWS will log a config error instead. When separate locationSets xml-files are used, each file can have its own <allowEmptyLocationSets> element, which will only apply for the location sets listed in that file.
sortByName
Deprecated. Sorting NOT used in dataviewer / filters. Sorting by name has become default, a sorting attribute can be defined in the location set <sortingLocationAttributeId>.
STILL used in exports
sortingLocationAttributeId
...
By configuring <chainageLocationAttributeId> all locations that have a value for this attribute will be contained in this location set. This attribute will automatically be used as sortingLocationAttributeId so the locations are in the order of ascending chainage value. The attribute must be of type numeric.
Code Block | ||
---|---|---|
| ||
LOCID;CHAINAGE_C;CHAINAGE_D;CHAINAGE_E
loc_a;0;;
loc_b;150;0;
loc_c;450;300;
loc_d;700;550;
loc_e;;;0
loc_f;;;50
loc_g;;;150
loc_h;;;300 |
Code Block | ||
---|---|---|
| ||
<attributeFile>
<csvFile>CHAINAGE_CDE.csv</csvFile>
<id>%ID%</id>
<timeZoneOffset>+00:00</timeZoneOffset>
<attribute id="CHAINAGE_C">
<text>%CHAINAGE_C%</text>
</attribute>
<attribute id="CHAINAGE_D">
<text>%CHAINAGE_D%</text>
</attribute>
<attribute id="CHAINAGE_E">
<text>%CHAINAGE_E%</text>
</attribute>
</attributeFile> |
Code Block | ||
---|---|---|
| ||
Code Block | ||
| ||
<locationSet id="CHAINAGE_CD"> <chainageLocationAttributeId>CHAINAGE_C<D</chainageLocationAttributeId> </locationSet> |
Code Block | ||
---|---|---|
| ||
<timeSeriesSet>
<moduleInstanceId>ExportRunMultipleTimeSeries</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>H.m</parameterId>
<chainageLocationSetId>CHAINAGE_D</chainageLocationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="day"/>
<relativeViewPeriod unit="day" start="-7" end="0"/>
<readWriteMode>read only</readWriteMode>
</timeSeriesSet>
|
Since 2020.02 it is possible to use time dependent chainage location attributes see Time Dependent Chainage Location Sets.
For configuring location attributes see all detailed information at the next page
...
With the XML example above, 2 river segment locationSets will be generated: Darwen_Warrington_Model_PDM (with 2 locations) and Dee_ISIS_Warrington_Model_PDM (with 3 locations).
LocationId | Name | River_Segment |
---|---|---|
713119 713120 67008 67015 67021 | Harrison Street PDM Ewood Blackburn PDM Pont Y Capel PDM Manley Hall PDM Lea Hall PDM | Darwen Darwen Dee_ISIS Dee_ISIS Dee_ISIS |
Note that sublocationsets can not be added to other locationsets. So it is adviced to create an overarching locationset (like UK_Fluvial_Catchments_PDM) from which sublocationsets are created by the function.
Label
It is possible to define a label that is presented in the map. For more information, see Explorer.
LocationSets and Tabular Config File Display
For new functionality in the Tabular Config Files Display, the locationSets have been extended with functionality to display column headers and check meta data in CSV/DBF files. The configuration of these elements can be found in the Tabular Config Files Display WIKI page.
- 20 Tabular Config Files Display#20TabularConfigFilesDisplay-ConfigureMetaDataColumnHeaders
- 20 Tabular Config Files Display#20TabularConfigFilesDisplay-ConfigureMetaDataRules