com.esri.arcgis.geometry
Interface IMSegmentation

All Superinterfaces:

IMCollection, java.io.Serializable

All Known Subinterfaces:

IMSegmentation2, IMSegmentation3, IMSegmentation4

All Known Implementing Classes:

IMSegmentation2Proxy, IMSegmentation3Proxy, IMSegmentation4Proxy, IMSegmentationProxy, Polygon, Polyline

public interface IMSegmentation
extends IMCollection, java.io.Serializable

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

Description: 'Provides access to members for defining an M-based linear coordinate system on a polyline or polygon.' 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	IIDfd5e17ec_d717_11d2_9f34_00c04f6bdf06
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.geometry.IMCollection

IID01faff20_5191_11d2_92f6_0000f875171d

Method Summary

void	calculateNonSimpleMs() Redefines the non-simple Ms to be values obtained from interpolation of surrounding defined Ms, or extrapolation of Ms.
void	extrapolateMs(int extrapolationStyle, int fromPart, int fromPoint, int toPart, int toPoint) Extrapolates the Ms at one or both ends of the geometry based on the M interval between the fromIndex and the toIndex.
java.lang.Object	getDistancesAtM(boolean asRatio, double m) Returns an array of distances along the polyline at which is located the specified M.
int	getMMonotonic() A value indicating whether Ms are monotonic, and if so, whether they are ascending or descending.
java.lang.Object	getMsAtDistance(double distance, boolean asRatio) Returns M values at the distance along the geometry.
IGeometryCollection	getPointsAtM(double m, double lateralOffset) Returns a multipoint geometry corresponding to the locations along the geometry where the specified M occurs.
IGeometryCollection	getSubcurveBetweenMs(double fromM, double toM) Returns a polyline geometry corresponding to the subcurve(s) between the fromM and the toM.
void	insertMAtDistance(double m, double distance, boolean asRatio, boolean createPart, boolean[] splitHappened, int[] newPartIndex, int[] newSegmentIndex) Sets the M value at the given distance along the geometry; creates a point at that distance if no point exists there.
void	interpolateMsBetween(int fromPart, int fromPoint, int toPart, int toPoint) Generates Ms by linear interpolation of segment distances for all vertices in the range [start+1, end-1].
void	reverseMsOrder() Reverses the order of the Ms along the geometry.
void	setAndInterpolateMsBetween(double fromM, double toM) Sets the Ms at the beginning and the end of the geometry and interpolates the M values between these values.
void	setMsAsDistance(boolean asRatio) Sets the M values to the cumulative length from the origin of the geometry.

Methods inherited from interface com.esri.arcgis.geometry.IMCollection

getMMax, getMMin, multiplyMs, offsetMs

Field Detail

IIDfd5e17ec_d717_11d2_9f34_00c04f6bdf06

static final int IIDfd5e17ec_d717_11d2_9f34_00c04f6bdf06

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

getMMonotonic

int getMMonotonic()
                  throws java.io.IOException,
                         AutomationException

A value indicating whether Ms are monotonic, and if so, whether they are ascending or descending.

Returns:

A com.esri.arcgis.geometry.esriMMonotonicEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMsAtDistance

java.lang.Object getMsAtDistance(double distance,
                                 boolean asRatio)
                                 throws java.io.IOException,
                                        AutomationException

Returns M values at the distance along the geometry. An array of one or two Ms is returned. Two Ms can be returned if the given distance is exactly at the beginning or ending of a part.

Parameters:

distance - The distance (in)

asRatio - The asRatio (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertMAtDistance

void insertMAtDistance(double m,
                       double distance,
                       boolean asRatio,
                       boolean createPart,
                       boolean[] splitHappened,
                       int[] newPartIndex,
                       int[] newSegmentIndex)
                       throws java.io.IOException,
                              AutomationException

Sets the M value at the given distance along the geometry; creates a point at that distance if no point exists there.

Parameters:

m - The m (in)

distance - The distance (in)

asRatio - The asRatio (in)

createPart - The createPart (in)

splitHappened - The splitHappened (out: use single element array)

newPartIndex - The newPartIndex (out: use single element array)

newSegmentIndex - The newSegmentIndex (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistancesAtM

java.lang.Object getDistancesAtM(boolean asRatio,
                                 double m)
                                 throws java.io.IOException,
                                        AutomationException

Returns an array of distances along the polyline at which is located the specified M. If the geometry's M's are monotonic along the geometry then the array will only have one element.

Parameters:

asRatio - The asRatio (in)

m - The m (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reverseMsOrder

void reverseMsOrder()
                    throws java.io.IOException,
                           AutomationException

Reverses the order of the Ms along the geometry.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolateMsBetween

void interpolateMsBetween(int fromPart,
                          int fromPoint,
                          int toPart,
                          int toPoint)
                          throws java.io.IOException,
                                 AutomationException

Generates Ms by linear interpolation of segment distances for all vertices in the range [start+1, end-1].

Parameters:

fromPart - The fromPart (in)

fromPoint - The fromPoint (in)

toPart - The toPart (in)

toPoint - The toPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAndInterpolateMsBetween

void setAndInterpolateMsBetween(double fromM,
                                double toM)
                                throws java.io.IOException,
                                       AutomationException

Sets the Ms at the beginning and the end of the geometry and interpolates the M values between these values.

Parameters:

fromM - The fromM (in)

toM - The toM (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMsAsDistance

void setMsAsDistance(boolean asRatio)
                     throws java.io.IOException,
                            AutomationException

Sets the M values to the cumulative length from the origin of the geometry.

Parameters:

asRatio - The asRatio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extrapolateMs

void extrapolateMs(int extrapolationStyle,
                   int fromPart,
                   int fromPoint,
                   int toPart,
                   int toPoint)
                   throws java.io.IOException,
                          AutomationException

Extrapolates the Ms at one or both ends of the geometry based on the M interval between the fromIndex and the toIndex.

Parameters:

extrapolationStyle - A com.esri.arcgis.geometry.esriExtrapolationEnum constant (in)

fromPart - The fromPart (in)

fromPoint - The fromPoint (in)

toPart - The toPart (in)

toPoint - The toPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateNonSimpleMs

void calculateNonSimpleMs()
                          throws java.io.IOException,
                                 AutomationException

Redefines the non-simple Ms to be values obtained from interpolation of surrounding defined Ms, or extrapolation of Ms.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointsAtM

IGeometryCollection getPointsAtM(double m,
                                 double lateralOffset)
                                 throws java.io.IOException,
                                        AutomationException

Returns a multipoint geometry corresponding to the locations along the geometry where the specified M occurs.

Parameters:

m - The m (in)

lateralOffset - The lateralOffset (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometryCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubcurveBetweenMs

IGeometryCollection getSubcurveBetweenMs(double fromM,
                                         double toM)
                                         throws java.io.IOException,
                                                AutomationException

Returns a polyline geometry corresponding to the subcurve(s) between the fromM and the toM.

Parameters:

fromM - The fromM (in)

toM - The toM (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometryCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.