Integrator Parameters Overview

See Parameters in Visual Integrator for information on how parameters are defined and used in VI.

The optional Parameter object allows you to create flexible scripts by storing user-defined variables referred to as parameters. Parameters can receive values external to the script at execution time. Parameters can be included in Object Language files so the same script can be used for multiple situations. A script can only contain one Parameter object.

Parameters are declared by including a parameter object labeled 'PARM' in the Integrator script. The PARM object must be named "parms". This name cannot be changed. This object has one attribute, also named "parms", which is an array of sub-objects defined for the object. One or multiple parameters can be defined with the sub-objects in the PARM object. The form of the PARM object is shown below:

object 'PARM' "parms" {
	parms = {
		{ name = "____",
		   type = "____",
		   default = "____",
		   environment = "____",
		},
		{ name = "____",
		   type = "____",
		   default = "____",
		   environment = "____",
		 },
		}
	};

It is recommended that you define the PARM object at the top of the Integrator script, just after the version "1"; statement, and just before the TSKL object Main statement. Once declared, a parameter can be used in a parameter string (see Parameter Strings) by other objects in the script.

See Parameter Attribute for a discussion of the PARM object's attributes.