IDL Reference Guide: iTools Object Classes

IDLitContainer::Get

The IDLitContainer::Get function method retrieves items from the container.

Syntax

Result = Obj->[IDLitContainer::]Get([, /ALL] [, COUNT=variable] [, ISA=string or array of strings] [, POSITION=index or array of indices] [, /SKIP_PRIVATE])

Return Value

Returns an object reference or array of object references to the iTool components stored in the container. Unless either the ALL keyword or the POSITION keyword is specified, the first object in the container is returned. If no objects are found in the container, the return value is -1.

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.

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.

SKIP_PRIVATE

Set this keyword to ignore any components for which the PRIVATE property is set to true. This keyword is ignored unless the ALL keyword is also set.

Version History

  IDL Online Help (March 06, 2007)