Transformation functions — hydrology & physical process

This page is the generated field list for the hydrology & physical process transformation functions — stage/discharge conversion, rainfall and soil moisture processing, longitudinal profiles, wave spectra, and structure-based discharge calculations (weirs, pumps). The function categories most specific to river/reservoir forecasting live here. Part of the transformation function catalogue; see that page for the shared <transformationModule>/<transformation> mechanics these all sit inside.

At a glance

Covers : stageDischarge / dischargeStage (convert water level ↔ flow, via table, power equation, merged rating curves, or a rating curve file reference), precipitation (tipping bucket → equidistant series, de-accumulation), moisture (optical depth, soil moisture — grid series only), profile (longitudinal profile ↔ time series), wave (generate 1D/2D wave spectra), structure (discharge through a configured weir or pump — Crump weir, flat-V weir, general weir, four pump variants).

Used inside : A <transformation>, <periodTransformation>, or <rangeTransformation> in a transformationModule file.

Related : Rating curves file (the ratingCurve variant references it by location) · Structures file (a separate, static catalog of pump/weir capacity — not the same mechanism as the structure transformation here).

Minimal example

Config/ModuleConfigFiles/ConvertStageToDischarge 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<transformationModule xmlns="http://www.wldelft.nl/fews" version="1.0">
  <transformation id="Gauge01_HQ">
    <stageDischarge>
      <table>
        <stage>
          <timeSeriesSet>
            <moduleInstanceId>ImportObservations</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>H.obs</parameterId>
            <locationId>Gauge01</locationId>
            <timeSeriesType>external historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>read only</readWriteMode>
          </timeSeriesSet>
        </stage>
        <discharge>
          <timeSeriesSet>
            <moduleInstanceId>ConvertStageToDischarge</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>Q.obs</parameterId>
            <locationId>Gauge01</locationId>
            <timeSeriesType>simulated historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>add originals</readWriteMode>
          </timeSeriesSet>
        </discharge>
        <coefficientSet>
          <type>level_to_flow</type>
          <authoriseExtrapolation>false</authoriseExtrapolation>
          <interpolationType>linear</interpolationType>
          <tableRecord stage="0.0" discharge="0.0"/>
          <tableRecord stage="1.0" discharge="12.5"/>
          <tableRecord stage="2.0" discharge="48.0"/>
        </coefficientSet>
      </table>
    </stageDischarge>
  </transformation>
</transformationModule>

Field reference

Note

structure alone is 10 variants (weirs and pumps) that together account for most of this page’s size — each pairs a physical formula with its own coefficientSet shape. If you’re not configuring hydraulic structures, skim past it to stageDischarge/dischargeStage, the pair almost every river system actually uses.

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

Function <dischargeStage>

Element	Type	Cardinality	Description
mergedRatingCurves	DischargeStageMergedRatingCurvesComplexType	required	Merges two rating curves using a time dependent weight variable and uses the resulting rating curve to convert discharge input values to stage output values. For each timeStep in the output time series, first the specified two rating curves are merged using the value of the weight input time series at that timeStep. If weight is 1, then uses the first rating curve. If weight is 0, then uses the second rating curve. If weight is between 0 and 1, then interpolates linearly between the first and the second rating curve to get the merged rating curve. Then the merged rating curve is used to convert the discharge input value for that timeStep to a stage output value. This can only use rating curves that are stored as time series in the dataStore. This uses the inverse of the equation Q_output = weight*Q_ratingCurve1(H_input) + (1 - weight)*Q_ratingCurve2(H_input)
power	DischargeStagePowerComplexType	required	Converts discharge (Q) to stage (H) for an open cross section. Uses equation Q=a*(H+b)^c.
table	DischargeStageTableComplexType	required	Converts discharge (water flow) to stage (water level) using a table with stage and discharge values.
ratingCurve	DischargeStageRatingCurveComplexType	required	Converts discharge (water flow) to stage (water level) using a rating curve(table or function)

Function <stageDischarge>

Element	Type	Cardinality	Description
mergedRatingCurves	StageDischargeMergedRatingCurvesComplexType	required	Merges two rating curves using a time dependent weight variable and uses the resulting rating curve to convert stage input values to discharge output values. For each timeStep in the output time series, first the specified two rating curves are merged using the value of the weight input time series at that timeStep. If weight is 1, then uses the first rating curve. If weight is 0, then uses the second rating curve. If weight is between 0 and 1, then interpolates linearly between the first and the second rating curve to get the merged rating curve. Then the merged rating curve is used to convert the stage input value for that timeStep to a discharge output value. This can only use rating curves that are stored as time series in the dataStore. This uses the equation Q_output = weight*Q_ratingCurve1(H_input) + (1 - weight)*Q_ratingCurve2(H_input).
power	StageDischargePowerComplexType	required	Converts stage (H) to discharge (Q) for an open cross section. Uses equation Q=a*(H+b)^c.
table	StageDischargeTableComplexType	required	Converts stage (water level) to discharge (water flow) using a table with stage and discharge values.
ratingCurve	StageDischargeRatingCurveComplexType	required	Converts stage (water level) to discharge (water flow) using a table with stage and discharge values.

Function <precipitation>

Element	Type	Cardinality	Description
tippingBucket	PrecipitationTippingBucketComplexType	required	Converts a non-equidistant time series with tipping bucket rainfall data to an equidistant time series with accumulated rainfall data.
deAccumulation	PrecipitationDeAccumulationComplexType	required	De-accumulation for precipitation time series. Values will be skipped and reset based on unreliable (void) flag and reset flag

Function <moisture>

Element	Type	Cardinality	Description
opticalDepth	MoistureOpticalDepthComplexType	required	Calculates optical depth. For grid time series only.
soilMoisture	MoistureSoilMoistureComplexType	required	Calculates soil moisture. For grid time series only.

Function <profile>

Element	Type	Cardinality	Description
timeSeries	ProfileTimeSeriesComplexType	required	Converts a profile to a time series.

Function <wave>

Element	Type	Cardinality	Description
piersonMoskowitzSpectrum1D	PiersonMoskowitzSpectrum1DComplexType	required	Since 2019.01 Transformation to generate Pierson-Moskowitz 1D wave spectrum from wave parameters
jonswapSpectrum1D	JonswapSpectrum1DComplexType	required	Since 2019.01 Transformation to generate Jonswap 1D wave spectrum from wave parameters
spectrum2D	Spectrum2DComplexType	required	Since 2019.01 Transformation to generate 2D wave spectrum from wave parameters

Function <structure>

Element	Type	Cardinality	Description
crumpWeir	StructureCrumpWeirComplexType	required	Converts stage to discharge.
crumpWeirBackwater	StructureCrumpWeirBackwaterComplexType	required	Converts stage to discharge, taking tailLevel into account.
flatVWeir	StructureFlatVWeirComplexType	required	Converts stage to discharge.
flatVWeirBackwater	StructureFlatVWeirBackwaterComplexType	required	Converts stage to discharge, taking tailLevel into account.
generalWeirFixedHeight	StructureGeneralWeirFixedHeightComplexType	required	General weir function which has a fixed height. The height is configured in the coefficient set.
generalWeirVariableHeight	StructureGeneralWeirVariableHeightComplexType	required	General weir function which has a variable height. The height is one of the input variables.
pumpFixedDischarge	StructurePumpFixedDischargeComplexType	required	Calculates discharge of a pump, using a fixed discharge when the pump is on. The fixed discharge is equal to the capacity of the pump and is defined in a coefficientSet.
pumpHeadDischargeTable	StructurePumpHeadDischargeTableComplexType	required	Calculates discharge of a pump. When the pump is on, then the discharge equals the capacity of the pump. The capacity of the pump depends on the head. The discharges for different heads are defined in a table in a coefficientSet.
pumpSpeedDischargeTable	StructurePumpSpeedDischargeTableComplexType	required	Calculates discharge of a speed-controlled pump with a fixed capacity. When the pump is on, then the discharge of the pump depends only on the speed. The discharges for different speeds are defined in a table in a coefficientSet.
pumpSpeedHeadDischargeTable	StructurePumpSpeedHeadDischargeTableComplexType	required	Calculates discharge of a speed-controlled pump with a head-dependent capacity. When the pump is on, then the discharge of the pump depends on both the speed and the head. The discharges for different speeds and heads are defined in a table in a coefficientSet.

DischargeStageMergedRatingCurvesComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
discharge	InputVariableComplexType	required	Input variable with discharge (water flow) values.
weight	InputVariableComplexType	required	Input variable with weight values.
ratingCurve	MergedRatingCurvesTransformationRatingCurveComplexType	required · repeats	References to two rating curves that are merged and used to convert discharge to stage values for this transformation. This can only use rating curves that are stored as time series in the dataStore. To import ratingCurves into the dataStore use timeSeriesImport module with importType pi_ratingcurves to import a file in the pi_ratingcurves.xsd format.
stage	OutputVariableComplexType	required	Output variable with stage (water level) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DischargeStagePowerComplexType

Converts discharge (Q) to stage (H) for an open cross section. Uses equation Q=a*(H+b)^c.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
discharge	InputVariableComplexType	required	Input variable with discharge (water flow) values.
stage	OutputVariableComplexType	required	Output variable with stage (water level) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StageDischargePowerCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StageDischargePowerCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

DischargeStageTableComplexType

Converts discharge (water flow) to stage (water level) using a table with stage and discharge values.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
discharge	InputVariableComplexType	required	Input variable with discharge (water flow) values.
stage	OutputVariableComplexType	required	Output variable with stage (water level) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StageDischargeTableCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

DischargeStageRatingCurveComplexType

Converts discharge (water flow) to stage (water level) using a table with stage and discharge values.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
discharge	InputVariableComplexType	required	Input variable with discharge (water flow) values.
stage	OutputVariableComplexType	required	Output variable with stage (water level) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
ratingCurve	RatingCurveLocationQualifierComplexType	required
qualifierId	idStringType	required

StageDischargeMergedRatingCurvesComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
stage	InputVariableComplexType	required	Input variable with stage (water level) values.
weight	InputVariableComplexType	required	Input variable with weight values.
ratingCurve	MergedRatingCurvesTransformationRatingCurveComplexType	required · repeats	References to two rating curves that are merged and used to convert stage to discharge values for this transformation. This can only use rating curves that are stored as time series in the dataStore. To import ratingCurves into the dataStore use timeSeriesImport module with importType pi_ratingcurves to import a file in the pi_ratingcurves.xsd format.
discharge	OutputVariableComplexType	required	Output variable with discharge (water flow) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

StageDischargePowerComplexType

Converts stage (H) to discharge (Q) for an open cross section. Uses equation Q=a*(H+b)^c.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
stage	InputVariableComplexType	required	Input variable with stage (water level) values.
discharge	OutputVariableComplexType	required	Output variable with discharge (water flow) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StageDischargePowerCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StageDischargePowerCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StageDischargeTableComplexType

Converts stage (water level) to discharge (water flow) using a table with stage and discharge values.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
stage	InputVariableComplexType	required	Input variable with stage (water level) values.
discharge	OutputVariableComplexType	required	Output variable with discharge (water flow) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StageDischargeTableCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StageDischargeRatingCurveComplexType

Converts stage (water level) to discharge (water flow) using a table with stage and discharge values.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
stage	InputVariableComplexType	required	Input variable with stage (water level) values.
discharge	OutputVariableComplexType	required	Output variable with discharge (water flow) values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
ratingCurve	RatingCurveLocationQualifierComplexType	required
qualifierId	idStringType	required

PrecipitationTippingBucketComplexType

Converts a non-equidistant time series with tipping bucket rainfall data to an equidistant time series with accumulated rainfall data.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
tippingBucketPrecipitation	InputVariableComplexType	required	Input variable with non-equidistant tipping bucket rainfall data.
defaultValue	float	optional	Default value for when there is no input value for the output value
maxInterpolationGapLength	TimeSpanComplexType	optional	If input time series contains a gap larger than maxInterpolationGapLength, then time steps at in between are set to missing in output.
maxExtrapolationGapLength	TimeSpanComplexType	optional	If input time series contains a gap larger than maxExtrapolationGapLength at the end, then time steps at the end are set to missing in output.
precipitation	OutputVariableComplexType	required	Output variable with an equidistant time series. For each time step in the output time series the input rainfall data between that time step and the previous output time step is accumulated.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

PrecipitationDeAccumulationComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Accumulated input variable
maxOutputValue	positiveFloat	required	If difference between 2 subsequent values is higher than maxDeAccumulatedValue , then time step is set to missing in output.
maxGapLength	TimeSpanComplexType	required	If input time series contains a gap larger than maxGapLength, then time step before gap is set to missing in output.
outputVariable	OutputVariableComplexType	required	DeAccumulated Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

MoistureOpticalDepthComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
horizontalSurfaceTemperature	InputVariableComplexType	required	Input variable.
verticalSurfaceTemperature	InputVariableComplexType	required	Input variable.
soilTemperature	InputVariableComplexType	required	Input variable.
soilMoisture	InputVariableComplexType	required	Input variable.
opticalDepth	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	MoistureOpticalDepthCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

MoistureSoilMoistureComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
horizontalSurfaceTemperature	InputVariableComplexType	required	Input variable.
verticalSurfaceTemperature	InputVariableComplexType	required	Input variable.
soilTemperature	InputVariableComplexType	required	Input variable.
soilMoisture	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	MoistureSoilMoistureCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

ProfileTimeSeriesComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputProfile	ProfileTimeSeriesInputVariableComplexType	required	Input variable.
type	profileTimeSeriesTypeEnumStringType	required	This is never used in the code. One of: simple, cyclic
outputVariable	OutputVariableComplexType	required	Time series variable to store data values from profile.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

PiersonMoskowitzSpectrum1DComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
frequencyAxis	FrequencyAxisComplexType	required	Definition of the frequency axis
significantWaveHeight	InputVariableComplexType	required	scalar time series of significant wave height [m]
peakWavePeriod	InputVariableComplexType	required	scalar time series of peak wave period [s]
output	OutputVariableComplexType	required	output scalar time series of 1D Pierson-Moskowitz spectrum
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

JonswapSpectrum1DComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
frequencyAxis	FrequencyAxisComplexType	required	Definition of the frequency axis
significantWaveHeight	InputVariableComplexType	required	scalar time series of significant wave height [m]
peakWavePeriod	InputVariableComplexType	required	scalar time series of peak wave period [s]
peakShapeGamma	InputVariableComplexType	required	scalar time series of non-dimensional peak shape parameter [-]
output	OutputVariableComplexType	required	output scalar time series of 1D JONSWAP spectrum
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

Spectrum2DComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
frequencyAxis	FrequencyAxisComplexType	required	Definition of the frequency axis
directionAxis	DirectionAxisComplexType	required	Definition of the direction axis
significantWaveHeight	InputVariableComplexType	required	scalar time series of significant wave height [m]
peakWavePeriod	InputVariableComplexType	required	scalar time series of peak wave period [s]
peakShapeGamma	InputVariableComplexType	required	scalar time series of non-dimensional peak shape parameter [-]
direction	InputVariableComplexType	required	scalar time series of nautical mean wave direction [deg], used to compute output variable spectrum2D
directionalSpreading	InputVariableComplexType	required	scalar time series of directional spreading [deg], used to compute output variable spectrum2D
output	OutputVariableComplexType	required	output scalar time series of wave energy density with two domainParameters (bins_freq, bins_dir) for a single location [m2/Hz/deg]
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

StructureCrumpWeirComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
headLevel	InputVariableComplexType	required	Input variable.
type	structureWeirTypeEnumStringType	required	One of: simple, crest_tapping
discharge	OutputVariableComplexType	required	Output variable with discharge values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructureCrumpWeirCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructureCrumpWeirCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructureCrumpWeirBackwaterComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
headLevel	InputVariableComplexType	required	Input variable.
tailLevel	InputVariableComplexType	required	Input variable.
type	structureWeirTypeEnumStringType	required	One of: simple, crest_tapping
discharge	OutputVariableComplexType	required	Output variable with discharge values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructureCrumpWeirCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructureCrumpWeirCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructureFlatVWeirComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
headLevel	InputVariableComplexType	required	Input variable.
type	structureWeirTypeEnumStringType	required	One of: simple, crest_tapping
discharge	OutputVariableComplexType	required	Output variable with discharge values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructureFlatVWeirCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructureFlatVWeirCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructureFlatVWeirBackwaterComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
headLevel	InputVariableComplexType	required	Input variable.
tailLevel	InputVariableComplexType	required	Input variable.
type	structureWeirTypeEnumStringType	required	One of: simple, crest_tapping
discharge	OutputVariableComplexType	required	Output variable with discharge values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructureFlatVWeirCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructureFlatVWeirCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructureGeneralWeirFixedHeightComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
headLevel	InputVariableComplexType	required	Input variable.
tailLevel	InputVariableComplexType	required	Input variable.
discharge	OutputVariableComplexType	required	Output variable with discharge values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructureGeneralWeirFixedHeightCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructureGeneralWeirFixedHeightCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructureGeneralWeirVariableHeightComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
headLevel	InputVariableComplexType	required	Input variable.
tailLevel	InputVariableComplexType	required	Input variable.
height	InputVariableComplexType	required	Input variable.
discharge	OutputVariableComplexType	required	Output variable with discharge values.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructureGeneralWeirVariableHeightCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructureGeneralWeirVariableHeightCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructurePumpFixedDischargeComplexType

Calculates discharge of a pump, using a fixed discharge when the pump is on. The fixed discharge is equal to the capacity of the pump and is defined in a coefficientSet.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
status	InputVariableComplexType	required	Input variable. Pump status (on = 1 or off = 0). Input can be equidistant or non-equidistant. The intermediate result (discharge) is calculated at all times in the status input series.
discharge	OutputVariableComplexType	required	Output variable. Discharge of the pump. The intermediate result is aggregated to this equidistant output time series.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructurePumpFixedDischargeCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructurePumpFixedDischargeCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructurePumpHeadDischargeTableComplexType

Calculates discharge of a pump. When the pump is on, then the discharge equals the capacity of the pump. The capacity of the pump depends on the head. The discharges for different heads are defined in a table in a coefficientSet.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
status	InputVariableComplexType	required	Input variable. Pump status (on = 1 or off = 0). Input can be equidistant or non-equidistant. The intermediate result (discharge) is calculated at all times in the status input series and at all times in the head input series.
head	InputVariableComplexType	required	Input variable. Difference between output and input water level for the pump. Head = downstreamWaterLevel - upstreamWaterLevel. Input can be equidistant or non-equidistant.
discharge	OutputVariableComplexType	required	Output variable. Discharge of the pump. The intermediate result is aggregated to this equidistant output time series.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructurePumpHeadDischargeTableCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructurePumpHeadDischargeTableCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructurePumpSpeedDischargeTableComplexType

Calculates discharge of a speed-controlled pump with a fixed capacity. When the pump is on, then the discharge of the pump depends only on the speed. The discharges for different speeds are defined in a table in a coefficientSet.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
status	InputVariableComplexType	required	Input variable. Pump status (on = 1 or off = 0). Input can be equidistant or non-equidistant. The intermediate result (discharge) is calculated at all times in the status input series and at all times in the speed input series.
speed	InputVariableComplexType	required	Input variable. A speed value is either the pump speed (Hz) or a percentage or fraction of the capacity of the pump. Input can be equidistant or non-equidistant.
discharge	OutputVariableComplexType	required	Output variable. Discharge of the pump. The intermediate result is aggregated to this equidistant output time series.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructurePumpSpeedDischargeTableCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructurePumpSpeedDischargeTableCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

StructurePumpSpeedHeadDischargeTableComplexType

Calculates discharge of a speed-controlled pump with a head-dependent capacity. When the pump is on, then the discharge of the pump depends on both the speed and the head. The discharges for different speeds and heads are defined in a table in a coefficientSet.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
status	InputVariableComplexType	required	Input variable. Pump status (on = 1 or off = 0). Input can be equidistant or non-equidistant. The intermediate result (discharge) is calculated at all times in the status input series, at all times in the speed input series and at all times in the head input series.
speed	InputVariableComplexType	required	Input variable. A speed value is either the pump speed (Hz) or a percentage or fraction of the capacity of the pump. Input can be equidistant or non-equidistant.
head	InputVariableComplexType	required	Input variable. Difference between output and input water level for the pump. Head = downstreamWaterLevel - upstreamWaterLevel. Input can be equidistant or non-equidistant.
discharge	OutputVariableComplexType	required	Output variable. Discharge of the pump. The intermediate result is aggregated to this equidistant output time series.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	StructurePumpSpeedHeadDischargeTableCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	StructurePumpSpeedHeadDischargeTableCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

TransformationRunPeriodComplexType

Element	Type	Cardinality	Description
relativePeriod	RelativePeriodComplexType	required
cardinalTimeStep	TimeStepComplexType	required	Aligns the start and end time of the run period of the transformation with this time step.
extendStart	boolean	required	Determines whether the start of the run period of the transformation should be extended or cropped to match the cardinal time step
extendEnd	boolean	required	Determines whether the end of the run period of the transformation should be extended or cropped to match the cardinal time step
startMonthDay	monthDayType	required
endMonthDay	monthDayType	required

InputVariableComplexType

Choose between a reference to a variable or an embedded definition of a variable.

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.

MergedRatingCurvesTransformationRatingCurveComplexType

Element	Type	Cardinality	Description
locationId	idStringType	optional
qualifierId	idStringType	required

OutputVariableComplexType

Choose between a reference to a variable or an embedded definition of a variable.

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.

StageDischargePowerCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
a	float	required	Coefficient a in equation Q=a*(H+b)^c.
b	float	required	Coefficient b in equation Q=a*(H+b)^c.
c	float	required	Coefficient c in equation Q=a*(H+b)^c.
type	stageDischargeCalculationTypeEnumStringType	required	Type of calculations for which this coefficientSet is valid. Level to flow, flow to level or both. One of: level_to_flow, flow_to_level, level_to_flow_and_flow_to_level

StageDischargePowerCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
a	string	required	Coefficient a in equation Q=a*(H+b)^c.
b	string	required	Coefficient b in equation Q=a*(H+b)^c.
c	string	required	Coefficient c in equation Q=a*(H+b)^c.
type	string	required	Type of calculations for which this coefficientSet is valid. Level to flow, flow to level or both.

StageDischargeTableCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
type	stageDischargeCalculationTypeEnumStringType	required	Type of calculations for which this coefficientSet is valid. Level to flow, flow to level or both. One of: level_to_flow, flow_to_level, level_to_flow_and_flow_to_level
authoriseExtrapolation	boolean	required	If true, then will extrapolate beyond table data without warning.
interpolationType	stageDischargeTableInterpolationTypeEnumStringType	required	If true, then will extrapolate beyond table data without warning. One of: linear, logarithmic
minimumStage	float	optional	minimum allowed stage value
tableRecord	StageDischargeTableRecordComplexType	required · repeats	One or more table records.

RatingCurveLocationQualifierComplexType

Element	Type	Cardinality	Description
locationId	idStringType	required
qualifierId	idStringType	optional

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

MoistureOpticalDepthCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
frequency	float	required
soilMoisture	float	required
incidenceAngle	float	required
scatteringAlbedo	float	required
polarizationFraction	float	required
roughness	float	required
soilPorosity	float	required

MoistureSoilMoistureCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
soilPorosity	float	required
frequency	float	required
soilMoisture	float	required	Starting value for soilMoisture (iterative process).
incidenceAngle	float	required
scatteringAlbedo	float	required
atmosphericOpacity	float	required
polarizationFraction	float	required
roughness	float	required

ProfileTimeSeriesInputVariableComplexType

Typical profile.

Element	Type	Cardinality	Description
timeStep	TimeStepComplexType	optional	Time step for this typical profile.
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Relative view period for this typical profile. This is never used in the code.
data	TimeSeriesDataComplexType	required · repeats	Defined time series data for this typical profile.
timeZone	TimeZoneComplexType	optional	Time zone for this typical profile.

FrequencyAxisComplexType

Element	Type	Cardinality	Description
frequencyLow	double	required
frequencyHigh	double	required
frequencyNumBins	positiveInteger	required

DirectionAxisComplexType

Element	Type	Cardinality	Description
directionalResolution	positiveInteger	required	directional bin resolution in degrees

StructureCrumpWeirCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
pUpValue	float	required
width	float	required
sSlope	float	required
dischargeCoefficient	float	required
energyHeadCorrection	boolean	required
singleCrest	StructureCrumpWeirSingleCrestComplexType	required
doubleCrest	StructureCrumpWeirDoubleCrestComplexType	required
tripleCrest	StructureCrumpWeirTripleCrestComplexType	required

StructureCrumpWeirCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
pUpValue	string	required
width	string	required
sSlope	string	required
dischargeCoefficient	string	required
energyHeadCorrection	string	required
singleCrest	StructureCrumpWeirSingleCrestFunctionsComplexType	required
doubleCrest	StructureCrumpWeirDoubleCrestFunctionsComplexType	required
tripleCrest	StructureCrumpWeirTripleCrestFunctionsComplexType	required

StructureFlatVWeirCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
pUpValue	float	required
width	float	required
cSlope	float	required
sSlope	float	required

StructureFlatVWeirCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
pUpValue	string	required
width	string	required
cSlope	string	required
sSlope	string	required

StructureGeneralWeirFixedHeightCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
height	float	required	Height of weir (m). Measured from upstream bed level to crest of weir. If crest level is omitted application assumes that weir is movable and a crest level value is expected as calculation input.
width	float	required	width of weir (m)
freeFlowLimitCoefficient	float	required	Limit coefficient defines when weir goes from free flowing to drowned flowing.
freeDischargeCoefficient	float	required	Discharge coefficient (-) for free flowing weir.
drownedDischargeCoefficient	float	required	Discharge coefficient (-) for drowned flowing weir.

StructureGeneralWeirFixedHeightCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
height	string	required	Height of weir (m). Measured from upstream bed level to crest of weir. If crest level is omitted application assumes that weir is movable and a crest level value is expected as calculation input.
width	string	required	width of weir (m)
freeFlowLimitCoefficient	string	required	Limit coefficient defines when weir goes from free flowing to drowned flowing.
freeDischargeCoefficient	string	required	Discharge coefficient (-) for free flowing weir.
drownedDischargeCoefficient	string	required	Discharge coefficient (-) for drowned flowing weir.

StructureGeneralWeirVariableHeightCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
width	float	required	width of weir (m)
freeFlowLimitCoefficient	float	required	Limit coefficient defines when weir goes from free flowing to drowned flowing.
freeDischargeCoefficient	float	required	Discharge coefficient (-) for free flowing weir.
drownedDischargeCoefficient	float	required	Discharge coefficient (-) for drowned flowing weir.

StructureGeneralWeirVariableHeightCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
width	string	required	width of weir (m)
freeFlowLimitCoefficient	string	required	Limit coefficient defines when weir goes from free flowing to drowned flowing.
freeDischargeCoefficient	string	required	Discharge coefficient (-) for free flowing weir.
drownedDischargeCoefficient	string	required	Discharge coefficient (-) for drowned flowing weir.

StructurePumpFixedDischargeCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
discharge	float	required	Fixed discharge of the pump, when the pump is on.

StructurePumpFixedDischargeCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
discharge	string	required	Fixed discharge of the pump, when the pump is on.

StructurePumpHeadDischargeTableCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
headDischargeTableRecord	StructurePumpHeadDischargeTableRecordComplexType	required · repeats	One or more table records. Each record lists the discharge of the pump for a given head. Heads need to be in ascending order. For input head values between records linear interpolation will be applied to get the discharge. For input head values outside the table range a debug message is logged and the closest defined head value is used to get the discharge.

StructurePumpHeadDischargeTableCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
headDischargeTableRecord	StructurePumpHeadDischargeTableRecordFunctionsComplexType	required	One table record with functions that contain location attribute ids. Define multiple values for the location attributes to get multiple table records. Each record lists the discharge of the pump for a given head. Heads need to be in ascending order. For input head values between records linear interpolation will be applied to get the discharge. For input head values outside the table range a debug message is logged and the closest defined head value is used to get the discharge.

StructurePumpSpeedDischargeTableCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
speedDischargeTableRecord	StructurePumpSpeedDischargeTableRecordComplexType	required · repeats	One or more table records. Each record lists the discharge of the pump for a given speed. Speeds need to be in ascending order. For input speed values between records linear interpolation will be applied to get the discharge. For input speed values outside the table range a debug message is logged and the closest defined speed value is used to get the discharge.

StructurePumpSpeedDischargeTableCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
speedDischargeTableRecord	StructurePumpSpeedDischargeTableRecordFunctionsComplexType	required	One table record with functions that contain location attribute ids. Define multiple values for the location attributes to get multiple table records. Each record lists the discharge of the pump for a given speed. Speeds need to be in ascending order. For input speed values between records linear interpolation will be applied to get the discharge. For input speed values outside the table range a debug message is logged and the closest defined speed value is used to get the discharge.

StructurePumpSpeedHeadDischargeTableCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
speedHeadDischargeTableRecord	StructurePumpSpeedHeadDischargeTableRecordComplexType	required · repeats	One or more table records. Each record lists the discharge of the pump for a given speed and head. The records need to be sorted on speed values. The speed values need to be in ascending order and for each speed value the head values need to be in ascending order. For input speed and/or head values between records linear interpolation will be applied to get the discharge. For input speed and/or head values outside the table range a debug message is logged and the closest defined speed and/or head value is used to get the discharge.

StructurePumpSpeedHeadDischargeTableCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
speedHeadDischargeTableRecord	StructurePumpSpeedHeadDischargeTableRecordFunctionsComplexType	required	One table record with functions that contain location attribute ids. Define multiple values for the location attributes to get multiple table records. Each record lists the discharge of the pump for a given speed and head. The records need to be sorted on speed values. The speed values need to be in ascending order and for each speed value the head values need to be in ascending order. For input speed and/or head values between records linear interpolation will be applied to get the discharge. For input speed and/or head values outside the table range a debug message is logged and the closest defined speed and/or head value is used to get the discharge.

RelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time.

Attributes

Attribute	Use	Notes
start	required
end	required
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.
unit	required

Elements

Element	Type	Cardinality	Description
description	string	optional

TimeStepComplexType

Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone], times+[timeZone] + monthDays+[timeZone] ([]=optional)

Attributes

Attribute	Use	Notes
id	optional	Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml. Only specify the id attribute when referring to a predefined time step. In the regionConfig/timeSteps.xml the time steps list both the id and the attributes that define the time step
label	optional	Short name for the time step which is shown to the user when he can choose one from a list.
unit	optional
divider	optional
multiplier	optional
times	optional	Defines the time step by a list of times without dates, e.g. "10:00 23:00"
minutes	optional	Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc.
daysOfMonth	optional	Defines the time step by a list of days of month, use "01 11 21" for a decade time step
monthDays	optional	Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for the meteorological seasons
timeZone	optional

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description of this timeStep. This is not used and is only present for convenience.

TimeSeriesSetComplexType

Attributes

Attribute	Use	Notes
id	optional
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
valueType	timeSeriesValueTypeStringType	required
parameterId	idStringType	required
domainParameterId	idStringType	optional · repeats	For a spectrum specify the frequency / wave length parameter. For a directional spectrum specify first the frequency parameter and secondly the directional parameter
qualifierId	idStringType	optional · repeats	Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd
timeSeriesType	timeSeriesTypeStringType	required
timeStep	TimeStepComplexType	required
aggregationPeriod	RelativePeriodComplexType	optional	The value at a time represents the aggregated value over the aggregation period e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents an aggregation (e.g. moving average) from 7:00 till 13:00 (including)
cycle	CalendarTimeSpanComplexType	optional	If cycle specified, then the data is repeated periodically with this cycle as the period length. There is original data for only one cycle. After that cycle the data will be repeated periodically. In other words, when cycle is defined, then a missing value is filled up with a value from the last available cycle before the missing value.
externalForecastSearchTimeStep	TimeStepComplexType	optional	Since 2024.01. Only time series with an external forecast time that match this time step are visible while searching
externalForecastTimeCardinalTimeStep	TimeStepComplexType	optional	When no external forecast exists in the data store younger that the specified age a new external forecast is returned with a minimum age that applies to the specified cardinal time step
qualifierAggregation	qualifierAggregationStringType	optional	When specified all the time series that have ALL the specified qualifiers are aggregated to a single time series on read. Can not be specified when this time series set is meant for writing
readWriteMode	timeSeriesReadWriteModeStringType	required	Note: this readWriteMode is only used in the TimeSeriesDisplay. Other modules ignore this readWriteMode.
synchLevel	intStringType	optional
expiryTime	CalendarTimeSpanComplexType	optional
delay	TimeShiftComplexType	optional
multiplier	floatStringType	optional
divider	floatStringType	optional
incrementer	floatStringType	optional
ensembleId	idStringType	optional	Optional field for running ensembles. Ensemble id's in a time series set will override ensemble id's defined in the workflow.
visibilityControllingFlagSourceColumnId	idStringType	optional	All values that not passed this validation step are removed on read. Set to missing for equidistant and removed for non-equidistant
onlyReliableFlagSourceColumnId	idStringType	optional	Since 2022.02. All values that passed this validation step and are reliable will be included other will be set to missing for equidistant and removed for non-equidistant. This will work as an "or" operation together with "visibilityControllingFlagSourceColumnId", so data should either have passed "visibilityControllingFlagSourceColumnId" or "onlyReliableFlagSourceColumnId".
locationRelationId	idStringType	required	Relation id to map the time series set locations to related locations. Instead of the time series set locations the related locations are used to read/write the time series.
skipLocationsWithoutRelation	boolean	optional	Since 2020.01 When true locations that do not have a related location will be skipped, when false all location must have a related location. Default is false
moduleInstanceId	idStringType	required · repeats
moduleInstanceSetId	idStringType	required	Query a single module instance in the data store that is available for this time series set
filterModuleInstanceSetId	idStringType	required	Query all module instances in the data store that are available for this time series set
locationId	idStringType	required · repeats
locationSetId	idStringType	required
chainageLocationSetId	idStringType	required	Id of location set which represents a chainage of locations. This can only be used in combination with readWriteMode readOnly
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative the time 0 of the workflow or the system time of the fews explorer
relativeForecastPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative to first time of a simulated or external forecast time series
ensembleMemberId	nonEmptyStringType	required · repeats	Optional field used for reading or writing one or more particular ensemble member
ensembleMemberIndex	nonNegativeIntegerStringType	required	Optional field used for reading or writing one particular ensemble member
ensembleMemberIndexRange	EnsembleMemberIndexRangeComplexType	required	Optional field used for reading or writing one particular sub set of the ensemble
relativeForecastSearchPeriod	TimeSeriesSetRelativePeriodComplexType	required	Since 2015.02. The latest available external forecast in this period will be read. By default the latest before time0 is returned
externalForecastTimeId	idStringType	required	Since 2018.01. Forecast time reference id configured in the forecast length estimator config. Can only be used in workflows and only after the forecast length estimator.
externalForecastMinAge	TimeSpanComplexType	optional	Since 2014.02. By default is there is no minimum age. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0
externalForecastMaxAge	TimeSpanComplexType	optional	By default is there is no maximum age so the returned external forecast can be very old when there is no recent forecast available. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0

StageDischargeTableRecordComplexType

Attributes

Attribute	Use	Notes
stage	required	Stage value.
discharge	required	Discharge value.
offset	optional	Offset value which is valid for this and higher stages

TimeSeriesSetRelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time. When the start time is not specified it is determined by the start time of the state of the current run. When the start is overrulable the time is overruled by the start of search period or the start of cold state run when one of two is specified When the end is overrulable this time is overruled by the end of the forecast when specified

Attributes

Attribute	Use	Notes
unit	required
start	optional	e.g. -1 hour means one before time 0
end	required	e.g. 1 hour means one hour after time 0
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.

Elements

Element	Type	Cardinality	Description
description	string	optional

TimeSeriesDataComplexType

defined data input as per time series format date time (defined either by dateTime or time or month day) and value

Attributes

Attribute	Use	Notes
monthDay	optional
dayofWeek	optional
monthofYear	optional
dateTime	optional
time	optional
value	required
comment	optional

TimeZoneComplexType

Element	Type	Cardinality	Description
timeZoneOffset	timeZoneOffsetStringType	required
timeZoneName	timeZoneStringType	required

StructureCrumpWeirSingleCrestComplexType

Element	Type	Cardinality	Description
crest1	StructureCrumpWeirFirstCrestComplexType	required

StructureCrumpWeirDoubleCrestComplexType

Element	Type	Cardinality	Description
crest1	StructureCrumpWeirFirstCrestComplexType	required
crest2	StructureCrumpWeirNextCrestComplexType	required

StructureCrumpWeirTripleCrestComplexType

Element	Type	Cardinality	Description
crest1	StructureCrumpWeirFirstCrestComplexType	required
crest2	StructureCrumpWeirNextCrestComplexType	required
crest3	StructureCrumpWeirNextCrestComplexType	required

StructureCrumpWeirSingleCrestFunctionsComplexType

Element	Type	Cardinality	Description
crest1	StructureCrumpWeirFirstCrestFunctionsComplexType	required

StructureCrumpWeirDoubleCrestFunctionsComplexType

Element	Type	Cardinality	Description
crest1	StructureCrumpWeirFirstCrestFunctionsComplexType	required
crest2	StructureCrumpWeirNextCrestFunctionsComplexType	required

StructureCrumpWeirTripleCrestFunctionsComplexType

Element	Type	Cardinality	Description
crest1	StructureCrumpWeirFirstCrestFunctionsComplexType	required
crest2	StructureCrumpWeirNextCrestFunctionsComplexType	required
crest3	StructureCrumpWeirNextCrestFunctionsComplexType	required

StructurePumpHeadDischargeTableRecordComplexType

Attributes

Attribute	Use	Notes
head	required	Difference between output and input water level for the pump. Head = downstreamWaterLevel - upstreamWaterLevel.
discharge	required	Discharge of the pump for the corresponding head, when the pump is on.

StructurePumpHeadDischargeTableRecordFunctionsComplexType

Attributes

Attribute	Use	Notes
head	required	Difference between output and input water level for the pump. Head = downstreamWaterLevel - upstreamWaterLevel.
discharge	required	Discharge of the pump for the corresponding head, when the pump is on.

StructurePumpSpeedDischargeTableRecordComplexType

Attributes

Attribute	Use	Notes
speed	required	A speed value is either the pump speed (Hz) or a percentage or fraction of the capacity of the pump.
discharge	required	Discharge of the pump for the corresponding speed, when the pump is on.

StructurePumpSpeedDischargeTableRecordFunctionsComplexType

Attributes

Attribute	Use	Notes
speed	required	A speed value is either the pump speed (Hz) or a percentage or fraction of the capacity of the pump.
discharge	required	Discharge of the pump for the corresponding speed, when the pump is on.

StructurePumpSpeedHeadDischargeTableRecordComplexType

Attributes

Attribute	Use	Notes
speed	required	A speed value is either the pump speed (Hz) or a percentage or fraction of the capacity of the pump.
head	required	Difference between output and input water level for the pump. Head = downstreamWaterLevel - upstreamWaterLevel.
discharge	required	Discharge of the pump for the corresponding speed and head, when the pump is on.

StructurePumpSpeedHeadDischargeTableRecordFunctionsComplexType

Attributes

Attribute	Use	Notes
speed	required	A speed value is either the pump speed (Hz) or a percentage or fraction of the capacity of the pump.
head	required	Difference between output and input water level for the pump. Head = downstreamWaterLevel - upstreamWaterLevel.
discharge	required	Discharge of the pump for the corresponding speed and head, when the pump is on.

CalendarTimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeShiftComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

EnsembleMemberIndexRangeComplexType

Attributes

Attribute	Use	Notes
start	required
end	optional

StructureCrumpWeirFirstCrestComplexType

Element	Type	Cardinality	Description
relativeLevel	float	required	Relative level for this crest (A).

StructureCrumpWeirNextCrestComplexType

Element	Type	Cardinality	Description
relativeLevel	float	required	Relative level for this crest (A).
width	float	required	Width for this crest (B).

StructureCrumpWeirFirstCrestFunctionsComplexType

Element	Type	Cardinality	Description
relativeLevel	string	required	Relative level for this crest (A).

StructureCrumpWeirNextCrestFunctionsComplexType

Element	Type	Cardinality	Description
relativeLevel	string	required	Relative level for this crest (A).
width	string	required	Width for this crest (B).

Gotchas

• Two unrelated ways to get a rating curve into a transformation. The ratingCurve variant of stageDischarge/dischargeStage looks up a curve from the standalone Rating curves file by locationId (+ optional qualifierId). The table/power/ mergedRatingCurves variants instead take an inline or file-referenced coefficientSet (coefficientSetId/coefficientSetFile, from a Config/CoefficientSetsFiles/transformationCoefficientSets file — a different, not-yet-documented file family). Don’t mix the two up: a coefficientSetId typo won’t fall back to RatingCurves.xml.
• stageDischarge and dischargeStage are mirror images, not the same function with a flag — pick the one that names your actual conversion direction; each has its own table/power/ratingCurve/ mergedRatingCurves variants.
• interpolationType: logarithmic on a table coefficientSet matters for discharge behavior near the low end of a rating — log interpolation avoids the unrealistic straight-line discharge a linear table can produce just above zero flow. Worth checking against gauged low-flow data if you see odd values there.
• structure functions need the matching coefficientSet shape for their variant — e.g. generalWeirFixedHeight’s height lives in the coefficient set, generalWeirVariableHeight’s comes from an input variable instead. Swapping variants without also updating the coefficientSet shape is a common source of a config that loads but computes nonsense.
• moisture functions are grid-only — opticalDepth and soilMoisture both require grid time series input; pointing them at a scalar series is a config error, not a silent no-op.

See also

• Reference: Transformation functions — basics · Temporal reshaping · Interpolation & spatial · Statistics
• Related references: Rating curves file · Structures file
• Task guide: Transformations
• Schema: transformationTypes.xsd