IDL Reference Guide: Miscellaneous Object Classes

IDL_Container::Get

The IDL_Container::Get function method returns an array of object references to objects in a container. Unless the ALL or POSITION keywords are specified, the first object in the container is returned. If no objects are found in the container, the Get function returns -1.

Syntax

Result = Obj->[IDL_Container::]Get ([, /ALL [, ISA=class_name(s)] | , POSITION=index] [COUNT=variable] )

Arguments

None.

Keywords

ALL

Set this keyword to return an array of object references to all of the objects in the container.

COUNT

Set this keyword equal to a named variable that will contain the number of objects selected by the function. If the ALL keyword is also specified, specifying this keyword is the same as calling the IDL_Container::Count method.

ISA

Set this keyword equal to a class name or vector of class names. This keyword is used in conjunction with the ALL keyword. The ISA keyword filters the array returned by the ALL keyword, returning only the objects that inherit from the class or classes specified by the ISA keyword.

POSITION

Set this keyword equal to a scalar or array containing the zero-based indices of the positions of the objects to return.

Version History

  IDL Online Help (March 06, 2007)