ENVIHydratable

This is an abstract interface class that is subclassed by any class that wants to support serialization to a hash representation. You cannot directly instantiate this class, but you must subclass it in order to use it. You can identify the inheritance of this class using the IDL ISA or OBJ_ISA function and specifying this class name as the second argument.

For additional information, see What are Hydrate and Dehydrate routines used for?

Syntax

Result = [ENVIHydratable].Dehydrate, ERROR=value

Return Value

The return value of this function is subclass specific.

Note: Subclasses of ENVIHydratable that do not override Dehydrate will throw an error identifying the missing implementation.

Methods

Dehydrate

Arguments

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.

Version History

ENVI 5.3.1

Introduced

API Version

4.2

See Also

ENVIHydrate, ENVIHydratable::Dehydrate