com.esri.arcgis.system
Interface ISet

All Superinterfaces:
Serializable
All Known Implementing Classes:
GroupFeedback, ObjectList, Set

public interface ISet
extends Serializable

Provides access to members that control a simple set of objects.

Description

The ISet interface provides properties and methods for adding objects, removing objects, and sequentially accessing objects in a Set.

When To Use

The Set object holds a collection of homogeneous or heterogeneous objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(Object unk)
          Adds an object to the set.
 boolean find(Object unk)
          Searches for the object in the set.
 int getCount()
          The element count of the set.
 Object next()
          Returns the next object in the set.
 void remove(Object unk)
          Removes the object from the set.
 void removeAll()
          Removes all objects from the set.
 void reset()
          Resets the set for enumerating through the objects with Next.
 

Method Detail

add

void add(Object unk)
         throws IOException,
                AutomationException
Adds an object to the set.

Description

Adds the specified object to the Set. If you add the same object to a Set twice, no error occurs but the resulting Set has only one reference to the object.

Remarks

The order in which objects are added to the Set using Add is not guaranteed to be the same order in which they are returned by the Next method.

When adding an object to a Set, you are merely adding a new reference to the object not copying it. The reference is released when the Set is destroyed or the object is removed. For example, if you add geodatabase features to a Set (or an Array) using a feature cursor, you must use a non-recycling cursor, otherwise the memory location of the previous feature is overwritten.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
unk - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

void remove(Object unk)
            throws IOException,
                   AutomationException
Removes the object from the set.

Description

Removes the reference to the specified object from the Set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
unk - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Removes all objects from the set.

Description

Removes all references to objects from the Set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

boolean find(Object unk)
             throws IOException,
                    AutomationException
Searches for the object in the set.

Description

Indicates whether a reference to the specified object has been added to the Set with the Add method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
unk - A reference to another Object (IUnknown) (in)
Returns:
The found
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

Object next()
            throws IOException,
                   AutomationException
Returns the next object in the set.

Description

The Next method returns the next object in the Set.

Remarks

The order that objects are returned from the Set object using the Next method is not guaranteed to be the same order as they were passed into the Add method. However, the Next method will return the objects in the same order.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Resets the set for enumerating through the objects with Next.

Description

The Reset method resets the Set so that the next call to the Next method returns the first object in the Set.

Remarks

The order that objects are returned from the Set object using the Next method is not guaranteed to be the same order as they were passed into the Add method. However, the Next method will return the objects in the same order.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException
The element count of the set.

Description

Returns the number of objects in the Set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.