...
The panel which is used for this modifier is very similar to the panel of the time series modifier.
The dropdowbox however difference with the time series modifier panel is that the dropdownbox which is used to select an operation type is disabled and set to the type Missing.
...
An example of the missing value modifier is shown below.
SchemaConfiguration example
timeseries
This tag can be used to identify to which timeseries this modifier should be applied.
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
offsetDefaultStartTime
The offset start time compared to the option defined in defaultStartTime. For example when an offset of 1 day is configured
in this option and the defaultStartTime is set to timezero than the default starttime of the modifier will be set to
time zero plus 1 day. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
| Code Block | ||
|---|---|---|
| ||
<missingValueModifier id="setmsng" name="setmsng">
<timeSeries>
<moduleInstanceId>ImportIHFSDB</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>STG</parameterId>
<locationSetId>Gages_AK</locationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="hour" multiplier="6"/>
</timeSeries>
<timeSeries>
<moduleInstanceId>ImportIHFSDB</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>STG</parameterId>
<locationSetId>Gages_AK</locationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="hour" multiplier="1"/>
</timeSeries>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
<resolveInWorkflow>false</resolveInWorkflow>
<resolveInPlots>true</resolveInPlots>
</missingValueModifier> |
timeseries
This tag can be used to identify to which timeseries this modifier should be applied.
defaultStartTime
The default start defaultEndTime
The default end time of the modifier. The available options are startrun and time zero and end run. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.offsetDefaultEndTime
offsetDefaultStartTime
The offset start time compared to the option defined in defaultStartTime. For example when an offset of 1 day is configured
in this option and the defaultStartTime is set to timezero than the default starttime of the modifier will be set to
time zero plus 1 day. It
The offset of the end time compared to the option defined in defaultEndTime. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
expiryTime
This tag can be used to overrule the default expiry time. The expiryTime is not related to the display (and is thus hidden from the user) and can be used to maximize the period a rating table modifier can be applied. This expiryTime is related to the period to which the modifier is applied, it does not indicate the period after which the rating table will be removed by the rollingBarrel. By using this option, you can overrule the default expiryTime.
resolveInWorkflow
In the tag timeSeries is a filter defined which defines which timeseries can be modified with this timeseries. If the tag
resolveInWorkflow is set than the modifier can be applied to all timeseries in the current workflow to which the defined time
series filter applies. In an IFD-environment the current workflow is the workflow which is associated to the selected topology
node.
resolveInPlots
This tag can only be used in IFD-environments. If this tag is enabled than the timeseries-filter is also applied to all timseries
in the plots associated with the current selected topologynode.
Below an example of the configuration of a missing value modifier.
<missingValueModifier id="setmsng" name="SETMSNG"> <timeSeries> <parameterId>QIN</parameterId> </timeSeries> <defaultStartTime>start run</defaultStartTime> <offsetDefaultStartTime unit="day" multiplier="1"/> <defaultEndTime>time zero</defaultEndTime> <offsetDefaultEndTime unit="day" multiplier="100"/> <expiryTime unit="day" multiplier="100"/> <resolveInWorkflow>false</resolveInWorkflow> <resolveInPlots>true</resolveInPlots> </missingValueModifier>
This missing value modifier can only be applied to time series which have the parameterid QIN because the tag timeseries defines a timeseries-filter with parameterId QIN.
When a missing value modifier is created from the modifiers panel by default the start time of the modifier will be equal to the start of the run plus 1 day.
The end of the modifier will default to time zero plus 100 days.
defaultEndTime
The default end time of the modifier. The available options are time zero and end run. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
offsetDefaultEndTime
The offset of the end time compared to the option defined in defaultEndTime. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
expiryTime
This tag can be used to overrule the default expiry time. The expiryTime is not related to the display (and is thus hidden from the user) and can be used to maximize the period a rating table modifier can be applied. This expiryTime is related to the period to which the modifier is applied, it does not indicate the period after which the rating table will be removed by the rollingBarrel. By using this option, you can overrule the default expiryTime.
resolveInWorkflow
In the tag timeSeries is a filter defined which defines which timeseries can be modified with this timeseries. If the tag
resolveInWorkflow is set than the modifier can be applied to all timeseries in the current workflow to which the defined time
series filter applies. In an IFD-environment the current workflow is the workflow which is associated to the selected topology
node.
resolveInPlots
This tag can only be used in IFD-environments. If this tag is enabled than the timeseries-filter is also applied to all timseries
in the plots associated with the current selected topologynodeThe tag resolveInWorkflow is set to false and the resolveInPlots tag is set to true which means that the modifier can be applied to all time series in the plots of the node, but will not be applied to the time series identified in the workflow of the node. In this example there are no time series defined to which this modifier should be applied. This means it can applied to all time series which are defined in the plots of a node.
Switch option modifier
This modifier allows the forecaster to choose one of the configured time series. If the chosen time series was defined as a timeValue-timeseries
than the forecaster will also have the option to enter a value. If the timeseries was defined as a boolean time series than the forecaster
cannot enter a value and the textbox for the value will be grayed out.
...