Script Editing Window

To access this window:

This window enables you to type or edit a Python script file for use within ProAVA2. This window has 2 panes: an code pane and a metadata pane with sub-tabs for input and output parameters, and general information.  

Code Pane

In the Code pane, type Python statements to create your script:

Inputs and Outputs Tabs

The Input and Outputs tabs each contain two sub-panes, a table pane and an editor pane.

The table columns and the editor boxes represent the same data about a parameter (but some columns may be hidden).

Name: The name of the parameter, which must be a valid Python identifier.

Description: A textual description of the parameter.

Default value: A value that should be used by the script if no value is provided for this parameter. This item is available only for input parameters.

Type: Select the datatype for the parameter.

Measure of: Select the type of quantity that the parameters values represent.

Unit system: Select the system of units that the parameter values will be converted to.

Visible: If selected, this parameter is displayed for the script in the Component Library Browser dialog browser.

When a parameter is selected in an Inputs or Outputs table, settings for the parameter appear in the corresponding editor sub-pane. specify input and output parameters, if any, for your script. This can be useful to pass values to or from other scripts or functions or to access model data, for example, when using the script in a function property of a layer, or as a step in a workflow.

General Tab

Name: The name of the script to display in the Component Library Browser dialog box.

Description: A textual description of what the script does.

Metadata:

This table can contain any metadata that you want to save along with your script. For example to make a script available for defining cases, add a metadata item with a Name of type and a Value of case_method.

 

Related Topics: