Versions Compared

Key

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

What

nameofinstrance.xml

Description

Configuration for the general adapter module

schema location

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

Entry in ModuleDescriptors

<moduleDescriptor id="GeneralAdapter">
<description>General Adaptor to launch published interface compliant modules</description>
<className>nl.wldelft.fews.system.plugin.generaladapter.GeneralAdapter</className>
</moduleDescriptor>

Table of Contents

...

  • type: indication of type of state to be imported. This may either be "directory" or "file". Note that multiple locations are supported only if type is "file".
    stateLocation

Root element of a state location

readLocation

Location where the external module will read the state. This is the location (and name of file/directory) where the General Adapter writes the state.

writeLocation

Location where the external module is expected to write the state. This is the location (and name of file/directory) where the General Adapter expects to read the state.

stateSelection

Root element to specify how a state to be exported to the external module is to be selected. Two main groups are available, cold states and warm states. Only one of these types can be specified. Note that if a warm state selection is specified and an appropriate warm state cannot be found, a cold state will be exported by default.

coldState

Root element for defining the stateSelection method to always export a cold state.

coldState:groupId

Id of the group of cold states to be used. This must be a groupId as defined in the ColdModuleInstanceStateGroups configuration (see Regional Configuration).

coldState:startDate

Definition of the start date of the external module run when using the cold state. This startDate is specified relative to the start time of the forecast run. A positive startDate means it is before the start time of the forecast run.

Attributes;

  • unit (enumeration of: second, minute, hour, day, week)
  • multiplier defines the number of units given above.**
  • divider same function as the multiplier, but defines fraction of units.**

...

  • unit (enumeration of: second, minute, hour, day, week)
  • start defines the start time relative to the start of the forecast run in number of units given above (negative is before start of forecast).**
  • end defines the end time relative to the start of the forecast run in number of units given above (negative is before start of forecast).**
    coldStateTime

Definition of the start time to use for a cold state if a suitable state is not found within the warm state search period.

Attributes;

  • unit (enumeration of: second, minute, hour, day, week)
  • value defines the start time of the cold state run relative to the start of the forecast run in number of units given above (negative is before start of forecast).**

...

  • asc : for exporting to ARC-INFO ASCII grid format
  • pcrgrid : for exporting to PCRaster native grid file format
  • usgsdem : for exporting to USGS DEM format (BIL)
    timeSerieSet

TimeSeriesSets to be exported. These should contain only one locationId. For exporting multiple grids, multiple exportMapStack activities should be defined.


exportProfilesActivity

Configuration of the exportProfiles activity is identical to the exportTimeSeries Activity.


Figure 73 Elements of the exportDataSets section

...

#time_0#

Time zero or forecast time. Note: deprecated, use %TIME0%\ instead

%TASK_ID%

current task id

%TIME_ZONE_OFFSET_SECONDS% |

the offset with GMT in seconds

%WORK_DIR%\

| work directory of general adapter

...