Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / ENVIParameterENVIGridDefinition

ENVI

ENVIParameterENVIGridDefinition

ENVIParameterENVIGridDefinition

Each ENVITask is defined by a set of parameters. Each has constraints on data type, values, etc. The ENVIParameterENVIGridDefinition object is used when an ENVITask has a parameter defined as type ENVIGridDefinition.

Syntax


Result = ENVIParameterENVIGridDefinition( [, Properties=value])

Properties

Properties can be set as keywords to the function during creation, or retrieved using the "." notation after creation. The NAME property is required on initialization. The VALUE property is the only property that can be updated after creation.

DEFAULT, DESCRIPTION, DIRECTION, DISPLAY_NAME, NAME, REQUIRED, TYPE, VALUE

Methods


Dehydrate

Hydrate

Validate

Return Value


The result is a reference to a newly created object.

Properties


DEFAULT

The value returned by the VALUE property if the user does not explicitly set VALUE. The default is !NULL. The values of this property must adhere to the TYPE property. In the task template this is defined with the default key.

DESCRIPTION

A string describing the purpose of the parameter with respect to the task. In the task template this is defined with the description key.

DIRECTION

A string that indicates whether the parameter acts as "INPUT" or "OUTPUT". The default is "INPUT". In the task template this is defined with the direction key.

DISPLAY_NAME

A string for the display name of the parameter that could be used to build a user interface. It can contain spaces and special characters. In the task template this is defined with the display_name key. If not set, the value will default to the NAME property's value.

NAME

The name of the parameter which is required on initialization. The parameter’s value can be set and retrieved from the ENVITask with the "." dot notation using this name. The name can also be used in the ENVITask::Parameter method to retrieve the parameter object. NAME must be a valid IDL variable name. In the task template this is defined with the name key. Use DISPLAY_NAME for a better user interface label.

REQUIRED

A boolean value that indicates whether the parameter is required or not. The default is 0, which allows the parameter to be optional. In the task template this is defined with the required key.

TYPE

When the type key is defined as ENVIGridDefinition in the task template, the ENVIParameterENVIGridDefinition object is created and populated with the key/value pairs defined in the template. The returned TYPE property is ENVIGridDefinition.

VALUE

The current value of the parameter. The parameter's VALUE can be set at any time through ENVITask using "." dot notation using the NAME of the parameter, or directly on the parameter object. The value of this property must adhere to the TYPE property. Setting this property will internally invoke the Validate() method, and will throw an error if the new value is invalid.

Version History


ENVI 5.4, Service Pack 1

Introduced

API Version


3.1.0

See Also


ENVITask, ENVITask::Parameter, ENVIGridDefinition



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us