com.esri.arcgis.geometry
Interface IEnumSegment

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IEnumSegmentProxy

public interface IEnumSegment
extends java.io.Serializable

COM Interface 'IEnumSegment'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeometry.olb'

Description: 'Provides access to members that iterate over collections of segments (obtained from the EnumSegments property on the ISegmentCollection interface).' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDc63faf0e_1040_11d1_a27d_0000f8775fbf
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void esri_clone(IEnumSegment[] outEnumerator)
          Returns a copy of this enumerator positioned at the same segment.
 boolean isLastInPart()
          Indicates if the current segment is last in the current part.
 boolean isRecycling()
          Indicates if this enumerator re-uses the same segment each time next is called.
 void next(ISegment[] outSegment, int[] outPartIndex, int[] segmentIndex)
          Returns the next segment, and its location in the collection.
 void nextEx(_esriSegmentInfo[] outSegment)
          Populates a segment info structure with information on the next segment in the collection.
 void nextInPart(ISegment[] outSegment, int[] outSegmentIndex)
          Returns the next segment in current part, goes back to first segment after last segment in part is encountered.
 void nextInPartEx(_esriSegmentInfo[] outSegment)
          Returns the next segment info structure in current part, goes back to first segment after last segment in part is encountered.
 void previous(ISegment[] outSegment, int[] outPartIndex, int[] segmentIndex)
          Returns the previous segment in this segment collection.
 void reset()
          Starts from the beginning of the segment collection the next time Next is called.
 void resetToEnd()
          Starts from the end of the path, ring, polyline or polygon the next time Previous is called.
 void setAt(int iPart, int iSegment)
          Resets enumerator to specific location.
 void skip(int numSegments)
          Skips forward or backward over a specified number of segments.
 

Field Detail

IIDc63faf0e_1040_11d1_a27d_0000f8775fbf

static final int IIDc63faf0e_1040_11d1_a27d_0000f8775fbf
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

nextEx

void nextEx(_esriSegmentInfo[] outSegment)
            throws java.io.IOException,
                   AutomationException
Populates a segment info structure with information on the next segment in the collection.

Parameters:
outSegment - A Structure: com.esri.arcgis.geometry._esriSegmentInfo (A com.esri.arcgis.geometry._esriSegmentInfo COM typedef) (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

void next(ISegment[] outSegment,
          int[] outPartIndex,
          int[] segmentIndex)
          throws java.io.IOException,
                 AutomationException
Returns the next segment, and its location in the collection. If the location does not have parts (i.e. a path or ring) then the part index will always be zero.

Parameters:
outSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)
outPartIndex - The outPartIndex (in/out: use single element array)
segmentIndex - The segmentIndex (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

skip

void skip(int numSegments)
          throws java.io.IOException,
                 AutomationException
Skips forward or backward over a specified number of segments.

Parameters:
numSegments - The numSegments (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws java.io.IOException,
                  AutomationException
Starts from the beginning of the segment collection the next time Next is called.

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

esri_clone

void esri_clone(IEnumSegment[] outEnumerator)
                throws java.io.IOException,
                       AutomationException
Returns a copy of this enumerator positioned at the same segment.

Parameters:
outEnumerator - A reference to a com.esri.arcgis.geometry.IEnumSegment (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetToEnd

void resetToEnd()
                throws java.io.IOException,
                       AutomationException
Starts from the end of the path, ring, polyline or polygon the next time Previous is called.

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

previous

void previous(ISegment[] outSegment,
              int[] outPartIndex,
              int[] segmentIndex)
              throws java.io.IOException,
                     AutomationException
Returns the previous segment in this segment collection.

Parameters:
outSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)
outPartIndex - The outPartIndex (in/out: use single element array)
segmentIndex - The segmentIndex (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAt

void setAt(int iPart,
           int iSegment)
           throws java.io.IOException,
                  AutomationException
Resets enumerator to specific location.

Parameters:
iPart - The iPart (in)
iSegment - The iSegment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextInPartEx

void nextInPartEx(_esriSegmentInfo[] outSegment)
                  throws java.io.IOException,
                         AutomationException
Returns the next segment info structure in current part, goes back to first segment after last segment in part is encountered.

Parameters:
outSegment - A Structure: com.esri.arcgis.geometry._esriSegmentInfo (A com.esri.arcgis.geometry._esriSegmentInfo COM typedef) (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextInPart

void nextInPart(ISegment[] outSegment,
                int[] outSegmentIndex)
                throws java.io.IOException,
                       AutomationException
Returns the next segment in current part, goes back to first segment after last segment in part is encountered.

Parameters:
outSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)
outSegmentIndex - The outSegmentIndex (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLastInPart

boolean isLastInPart()
                     throws java.io.IOException,
                            AutomationException
Indicates if the current segment is last in the current part.

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

isRecycling

boolean isRecycling()
                    throws java.io.IOException,
                           AutomationException
Indicates if this enumerator re-uses the same segment each time next is called.

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