QueryAllTasks Task

This task returns a hash where each key is the task name and each task name key contains a hash of the task's properties.

Example

; Start the application

e = ENVI(/HEADLESS)

 

; Get the task from the catalog of ENVITasks

Task = ENVITask('QueryAllTasks')

 

; Return only the ENVI tasks that

; compute convolution filters

Task.FILTER_TAGS = ['ENVI', 'Convolution Filters']

 

; Run the task

Task.Execute

 

; Print the tasks and parameters

Print, Task.TASK_DEFINITIONS

Syntax

Result = ENVITask('QueryAllTasks')

Input properties (Set, Get): FILTER_TAGS

Output properties (Get only): TASK_DEFINITIONS

Properties marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.

Methods

This task inherits the following methods from ENVITask:

AddParameter

Execute

Parameter

ParameterNames

RemoveParameter

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

COMMUTE_ON_SUBSET

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

This task also contains the following properties:

FILTER_TAGS (optional)

Set this property to an array of tags used to filter the queried tasks. ENVIQueryAllTasksTask returns tasks that meet the criteria for all specified tags, not just some of them. The tags are not case-sensitive. If no results are found, TASK_DEFINITIONS returns a value of !NULL.

TASK_DEFINITIONS (Get)

An ENVITaskCatalog hash that describes all tasks and their properties that meet the query criteria.

Version History

ENVI 5.3. 2

Introduced

ENVI 5.5.1

Added the FILTER_TAGS property

API Version

4.2

See Also

ENVITask, QueryTask, QueryTaskCatalog Task