Skip to content

StateDMI / Command / SetReservoirAggregate

Overview

The SetReservoirAggregate command (for StateMod) sets reservoir aggregate part identifier data for a reservoir:

  • a StateMod reservoir station

Aggregate reservoirs are defined as a combination of other reservoirs and may be used, for example, to aggregate stock ponds or other small reservoirs. This command should be specified before commands that need aggregate information during processing (e.g., those that read data from HydroBase). Aggregate information should be specified after reservoir stations are defined and before their use in other processing, such as reading data from HydroBase.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

SetReservoirAggregate command editor

SetReservoirAggregate Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

SetReservoirAggregate(Parameter="Value",...)

Command Parameters

Parameter             Description Default          
ID
required		 The reservoir identifier to associate with the aggregate part identifiers. None – must be specified.
PartIDs
required		 The list of part identifiers to comprise the aggregate. None – must be specified.
IfNotFound Used for error handling, one of the following:
  • Fail – generate a failure message if the ID is not matched
  • Ignore – ignore (don’t add and don’t generate a message) if the ID is not matched
  • Warn – generate a warning message if the ID is not matched
 Warn

Examples

See the automated tests.

Troubleshooting

See the main troubleshooting documentation

See Also