TVD Connector Data Fields (InfoWorks)

TVD Connector data can be edited on either the TVD Connector Grid Window of the Polygons Grid or the TVD Connector Property Sheet.

Most data can be edited on the grid, but some fields cannot be displayed in the grid format.

To view and edit all TVD connector data, use the Property Sheet.

The following describes all the data which can be used to define a TVD Connector.

Common Data Fields

Fields that are common to the majority of objects can be found in the Common Fields topic.

TVD Connector Data

Database Table Name: hw_tvd_connector

Show Columns

Database Names

Size, Type and Units

Defaults and Error Limits

Field Name

Help Text

Database Field

Data Type

Size

Units

Precision

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit
ID Unique identifier for the TVD connector. id Text 64   0          
Category

Optional user-defined category.

Category may be used when defining the order of priority of spatial rainfall data using Spatial Rain Sources.

 category_id Text 64   0          
X coord X coordinate of the object. x Double   XY 2          
Y coord Y coordinate of the object. y Double   XY 2          
Area Area covered by the connector. Default area is calculated from polygon geometry if connector is a polygon, or set to null if connector is a point. area Double   CA 3          
Input A units type The data measurement type for Input A. input_a_units Text 8   0          
Input A

This may be one of the following:

  • ID of a data stream in a Time Series Database.

    When referring to a data stream in a Time Series Database, prefix the ID with a '#'. e.g. #datastream1.

  • ID of another TVD connector.
  • A numerical constant. This should not be the same as the ID of another TVD connector

If a number is specified, InfoWorks ICM first checks if it matches any existing TVD connectors IDs. If it does, then InfoWorks ICM uses that TVD connector as the input. If not, the software treats the number as a constant with units determined by the Connector units field.

input_a Text 64   0          
Input B units type The data measurement type for Input B. input_b_units Text 8   0          
Input B

See Input A.

By default, inputs are used as a sequential data sources. For example, if a data stream is specified in Input A and it has missing values, the Input B data stream will be used to fill the gaps.

However, this field may also be simultaneously when, for example, calibrating PDM descriptors or in an SQL expression.

 input_b Text 64   0          
Input C units type The data measurement type for Input C. input_c_units Text 8   0          
Input C

See Input A.

By default, inputs are used as a sequential data sources. For example, if a data stream is specified in Input A and Input B fields and both have missing values at the same timesteps, the Input C data stream will be used to fill the gaps.

However, this field may also be simultaneously when, for example, calibrating PDM descriptors or in an SQL expression.

 input_c Text 64   0          
Output units type

The data measurement type for output from the TVD connector.

Note

Evaporation and temperature can be specified either as outputs of a TVD connector or as inputs to rainfall TVD connectors, but not both. If they do, the model will fail validation unless the Output units type field is left blank.

 output_units Text 8   0          
Connector units

Determines how any values calculated internally (by an explicitly-entered output expression or using inputs that are specified as numerical constants) should be converted into native units of the specified output type.

The options available in the dropdown list are populated when an Output units type is selected.

 output_units Text 8   0          
Output expression

The SQL expression used with this TVD connector.

An expression can be specified using the SQL Expression dialog which is displayed by clicking on the button.

Note

The SQL functions and operators which can be used in the expression are listed in the TVD Connector - SQL Expression Dialog topic.

An expression can also be tested from the dialog.

 output_expression Memo                
Resampling buffer

The resampling buffer is the length (in minutes) of the additional period of input data prior to the run start time which must be captured in order to ensure that resampled values at and shortly after the run start time are correct.

It should be non-zero only if the TVD connector has an expression that uses the TSRESAMPLE function.

                    
Connected object type

Type of network object that the TVD connector is connected to.

Use hw_rtc to connect to an RTC table. See Controlling Regulators using TVD Connectors for details.

 connected_object_type Text 32   0          
Connected object id

Enabled when Connected object type is set.

ID of the network object that the TVD connector is connected to.

If Connected object type is set to hw_rtc, the dropdown will contain a list of RTC tables.

 connected_object_id Text 66   0          
Connection usage

Enabled when Connected object id is set.

Database Value

Description

 Help Text
Input Input (default) The input to the TVD connector is used as an input to the network object specified in the Connected object id field.
Comparison Comparison

The input to the TVD connector will be available as results for comparison with the results of the network object specified in the Connected object id field.

An observed data trace will be displayed in pick graphs and graph reports.
Runoff ARMA

Runoff ARMA

(Runoff Error Prediction)

During ARMA error prediction calculations, the input to the TVD connector is used as input to the network object specified in the Connected object id field.

Note that this option is only available when the Connected object type is set to hw_subcatchment.
usage Text 16   0          
Input attribute

Enabled when Connection usage is set to Input and the Connected object id is set.

The data type of the data to be input to the connected network object.

 input_attribute Text 16   0          
Comparison result

Enabled when Connection usage is set to Comparison and the Connected object id is set.

The data type of the result data to be made available for comparison with the results of the connected network object.

 comparison_result Text 16   0          
ARMA ID

Enabled when Connection usage is set to Comparison and the Connected object type is set to hw_node or hw_1d_results_point or hw_2d_results_point.

The name of the ARMA error prediction model whose output is to be used by this TVD connector for post-processing forecast predictions.

The ARMA model name can be either typed into the field or selected from the dropdown list. Alternatively, a new model can be added or an existing one modified using the button located to the left of the field. This displays the non-visual object menu, from which you can select the appropriate option.

Note that if the Connected object type is set to:

  • hw_node - the Comparison Result must be set to DEPNOD (level)
  • hw_1d_results_point (Network results point (1D)) - the Comparison Result must be set to either FLOW, DEPTH or VELOCITY
  • hw_2d_results_point (Network results point (2D)) - the Comparison Result must be set to either DEPTH2D or SPEED2D
 arma_id Text 64              

TVD Connectors

TVD Connector - SQL Expression Dialog

Polygons

Polygons Grid

Property Sheets