CatchmentSIM

User Parameter Variables

Hide Navigation Pane

User Parameter Variables

Previous topic Next topic No directory for this topic No expanding text in this topic  

User Parameter Variables

Previous topic Next topic Topic directory requires JavaScript JavaScript is required for expanding text JavaScript is required for the print function Mail us feedback on this topic!  

Comments (...)

 

User Parameters

 

The following variables relate to the project's User Parameters .

 

Project Variable
(%UserParameters.)

Description

Output Type

Units

UserParametersExist

Returns True if user parameter(s)exist in the current project, otherwise False

True / False

 

NumberOfUserParameters

The number of User Parameters in the project.

integer

 

UserParameter[i].Name

The name of the User Parameter.

text

 

UserParameter[i].Method

The type of user parameter. Result is either 'Zonal Statistics' or 'Macro'

text

 

UserParameter[i].MacroText

The macro text in the case of a macro User Parameter.

text

 

UserParameter[i].Grid

The name of the grid in the case of a zonal statistics User Parameter.

text

 

UserParameter[i].ZStatsMethod

The zonal statistics method in the case of a zonal statistics User Parameter. The result is either 'Average', 'Min', 'Max' or 'Count'.

text

 

UserParameter[i].ZStatsIgnoreNoData

The status of the 'Ignore No Data' checkbox in the case of a zonal statistics User Parameter

True / False

 

UserParameter[i].Units

The units for the User Parameter.

text

 

UserParameter[i].IsNumerical

The status of the 'Is Numerical' checkbox.

True / False

 

UserParameter[i].Subcatchment[i].Value

The derived value of the User Parameter for the ith subcatchment.

text

 

 

 

 

 

 

 

 

 

Comments (...)