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.
e = ENVI(/HEADLESS)
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 machine to use as an ENVI Server. If the ENVI Server will be a local server, 'localhost' will be used. To connect to a remote ENVI Server, ENVI must be installed on the network computer and the ENVI Server must be configured and started.
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 the ENVI Server.
WORKSPACE (Get, Set)
Specify a folder for the workspace to use for the ENVI Server.
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
|