This function creates an ENVIServer object so that you can run multiple, concurrent ENVI processes in the background, in parallel, or distributed among different computers. See the ENVI Server help topic for more information.

Example

---

This example defines a local ENVIServer object that can be used to run jobs in the background.

; Start the application

e = ENVI(/HEADLESS)

; Create an ENVIServer

server = ENVIServer('localhost')

Syntax

---

Result = ENVIServer(URL [, Properties=value] [, ERROR=value])

Return Value

---

This routine returns a reference to an ENVIServer object.

Methods

---

Dehydrate

GetExecutedTask

GetJobStatus

GetQueuedJobs

GetSubmittedTask

Hydrate

SubmitTask

Arguments

---

URL

Optionally, specify the URL of the computer to be used as an ENVI Server. If this is not set, 'localhost' will be used. To connect to a remote ENVI Server, both ENVI and GSF must be installed on the remote computer. If you only want to run jobs in the background on your local machine (localhost), GSF installation is optional (GSF will be used if installed).

Properties

---

NAME (Get, Set)

Specify a string with the custom name of the ENVI Server.

URL (Get, Set)

Specify the URL of the ENVI Server.

VERSION (Get)

A string with the version of GSF that is running behind the ENVI Server. If GSF is not installed, the version of a local ENVI Server will be an empty string.

WORKSPACE (Get, Set)

Specify a fully qualified URI with the GSF workspace to be used for the ENVI Server. You must also configure the GSF workspace by editing the "root" value in the config.json file. See the ENVI Servers topic for instructions.

Keywords

---

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

---

ENVI 5.6	Introduced
ENVI 5.6.1	Added VERSION property