ENVIDataContainer

This is a reference to an ENVIDataContainer object, which is a group of data objects such as rasters and vectors as well as variables of any data type (strings, numbers, etc.) A data container keeps track of the state of data objects in a program. This way, you can close or save a data object and retrieve it later if you need it again.

Objects added to an ENVIDataContainer must be serializable via ENVIHydrate.

Example

; Start the application

e = ENVI(/HEADLESS)

 

; Create a data container

container = ENVIDataContainer()

 

; Add a scalar number to the container

container.AddScalar, 'classes', 5

 

Print, container.GetScalar('classes')

Syntax

Result = ENVIDataContainer([ERROR=value])

Return Value

This routine returns a reference to an ENVIDataContainer object.

Methods

AddArray

AddScalar

Dehydrate

GetArray

GetScalar

HasArray

HasScalar

Hydrate

RemoveArray

RemoveScalar

Arguments

None

Properties

None

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.

FOLD_CASE

By default, string keys are case-sensitive. Set this keyword to ignore the case when accessing keys, adding new keys, removing keys, or changing key values.

Version History

ENVI 5.6

Introduced

API Version

4.2

See Also

ENVIDataCollection