Skip to content
Delft-FEWS Config Guide

Cold module instance state groups file

This page is the generated field list for ModuleInstanceStateGroups.xml — named cold-state options a forecaster can pick from in the state-selection dialog when a module instance has no usable warm state (first run, gap after downtime, or a deliberate reset).

At a glance

Section titled “At a glance”

Purpose : Declares one defaultGroup (always available), any number of additionalGroups, and — since 2017.02 — seasonalGroups that are only offered within a configured month/day window (e.g. a snowmelt-season cold state).

Folder : Config/RegionConfigFiles/

Root element : <coldModuleInstanceStateGroups> (version="1.0", required)

Concept : See The forecasting lifecycle for cold vs. warm state in general.

Minimal example

Section titled “Minimal example”
Config/RegionConfigFiles/ModuleInstanceStateGroups.xml
<?xml version="1.0" encoding="UTF-8"?>
<coldModuleInstanceStateGroups xmlns="http://www.wldelft.nl/fews" version="1.0">
  <defaultGroup id="Default" name="Default cold state">
    <description>Standard cold start with no prior state</description>
  </defaultGroup>
  <seasonalGroup id="SnowmeltStart" name="Snowmelt season start">
    <description>Cold state tuned for the start of the snowmelt season</description>
    <season>
      <startMonthDay>--03-01</startMonthDay>
      <endMonthDay>--04-15</endMonthDay>
    </season>
  </seasonalGroup>
</coldModuleInstanceStateGroups>

Field reference

Section titled “Field reference”

Auto-generated from coldModuleInstanceStateGroups.xsd. Descriptions are the schema's own annotations.

Element <coldModuleInstanceStateGroups>

Attributes

AttributeUseNotes
version required fixed: 1.0.

Elements

ElementTypeCardinalityDescription
defaultGroup ColdModuleInstanceStateGroupComplexType required
seasonalGroup SeasonalColdModuleInstanceStateGroupComplexType optional · repeats
additionalGroup ColdModuleInstanceStateGroupComplexType optional · repeats

ColdModuleInstanceStateGroupComplexType

Attributes

AttributeUseNotes
id required
name optional

Elements

ElementTypeCardinalityDescription
description string optional

SeasonalColdModuleInstanceStateGroupComplexType

Attributes

AttributeUseNotes
id required
name optional

Elements

ElementTypeCardinalityDescription
description string optional
season SeasonConditionComplexType required Since 2017.02 Season this cold state is valid for

SeasonConditionComplexType

ElementTypeCardinalityDescription
startMonthDay monthDayType required Start month and day of this season.
endMonthDay monthDayType required End month and day of this season.

Gotchas

Section titled “Gotchas”
  • startMonthDay/endMonthDay use XML’s gMonthDay form: --MM-DD (note the leading --), not a plain MM-DD string.
  • defaultGroup is required and singular — it’s the fallback whenever no seasonal group matches the run’s time zero. additionalGroup and seasonalGroup are both optional and repeatable on top of it.
  • A seasonalGroup’s window (startMonthDay/endMonthDay) is evaluated against run time zero, not the state’s own timestamp — configure the window around when you want the option offered, not when the underlying state data is representative of.

See also

Section titled “See also”