Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


...

What

locationSets.xml

Required

no

Description

Definitions of groups of locations

schema location

http://fews.wldelft.nl/schemas/version1.0/locationSets.xsd

Contents

Table of Contents
excludeContents

...

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
titlecsv attribute file
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
titleLocationSets - reference to csv attribute file
<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
titleLocationSets - defenition of location setsxmlxml
	<locationSet id="CHAINAGE_CD">
		<chainageLocationAttributeId>CHAINAGE_C<D</chainageLocationAttributeId>
	</locationSet>


Code Block
titleuse of locationSet to display data
<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

...

This element can be used to generate multiple locationsets from location attributes; these are normally invluded for locations in dbf or CSV files. In the example below a locationSet is created Warrington_Fluvial_Catchments_PDM from locationSet UK_Fluvial_Catchments_PDM where the location attribute Centre contains Warrington. By using the subLocationSetIdFunction, multiple locationSets are generated as well for all river_segments that can be found in the locationattribute @River_Segment@.

 

Code Block
xml
xml
	<locationSet id="Warrington_Fluvial_Catchments_PDM">
		<subLocationSetIdFunction>@River_Segment@_Warrington_Model_PDM</subLocationSetIdFunction>
		<locationSetId>UK_Fluvial_Catchments_PDM</locationSetId>
		<constraints>
			<attributeTextContains id="Centre" contains="Warrington"/>
		</constraints>
	</locationSet>

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).

LocationIdName 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.