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


Harris Geospatial / Docs Center / IDL Reference / ESE API / ESETaskParameter

ESETaskParameter

ESETaskParameter

The ESETaskParameter class represents ESE task parameters.

Every parameter of an ESETask, whether input or output, is accessed via an ESETaskParameter object. Accessing the ESETaskParameter is not required.

The ESE API automatically validates and converts common data types between IDL variables and JSON (string forms of hashes, arrays, numbers, etc.). Non-standard types can be converted by custom routines specified to serialization and deserialization mechanism for the given ESE class.

Methods


None.

Example


Though task parameters do not have any methods, they can still be queried for their properties:

Task = ESE.GetTask('http://localhost:9191/ese/services/IDL/addition')
Param = Task.GetParameter('a')
PRINT, Param.DATATYPE
PRINT, Param.DIRECTION

Properties


CHOICELIST (Get)

The list of possible values to use.

DATATYPE (Get)

The name of the ESE datatype, or the name of the object that defines the data type, for example, 'ENVIRaster', for the parameter.

DEFAULTVALUE (Get)

The value to use when running the task if no specific input is supplied.

DIRECTION (Get)

Either 'input' or 'output'.

DISPLAYNAME (Get)

The name of the service.

MAX (Get)

The maximum value to use when setting values.

MIN (Get)

The minimum value to use when setting values.

NAME (Get)

The name of the parameter.

PARAMETERTYPE (Get)

Either 'required' or 'optional'.

VALUE (Get, Set)

The currently stored value for the parameter.

Version History


IDL 8.4.1 Introduced
IDL 8.5.2 Deprecated Step Property

See Also


ESE, ESETask



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