com.esri.arcgis.geometry
Interface IMAware

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Envelope, IMAwareProxy, MultiPatch, Multipoint, Point, Polygon, Polyline, TriangleFan, Triangles, TriangleStrip

public interface IMAware

extends java.io.Serializable

Indicator interface that identifies geometric objects that can have persistent M values attached to their vertices.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

Controls whether or not the geometry object recognizes that it should use the M attributes when performing operations. Some methods using Ms require that an object is Aware of Ms before they can be called, others function regardless of MAwareness. IMAware also allows those Ms to be Dropped (reset to NaN). The M attribute is a measure that can be used similar to an address for determining position along a path. Simple Ms have non-NaN double values.

Method Summary

void	dropMs() Sets all the M values to a non-valid number (NaN).
boolean	isMAware() Indicates whether or not the geometry is aware of and capable of handling Ms.
boolean	isMSimple() Indicates if all the Ms are valid numbers.
void	setMAware(boolean mAware) Indicates whether or not the geometry is aware of and capable of handling Ms.

Method Detail

isMAware

public boolean isMAware()
                 throws java.io.IOException,
                        AutomationException

Indicates whether or not the geometry is aware of and capable of handling Ms.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or sets the M Awareness state of the geometry object. If MAware is TRUE, then the object will recognize that it has M attributes and perform operations on them as necessary. If MAware is FALSE, the object will ignore Ms while performing operations.

Returns:

The mAware

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMAware

public void setMAware(boolean mAware)
               throws java.io.IOException,
                      AutomationException

Indicates whether or not the geometry is aware of and capable of handling Ms.

Supported Platforms

Windows, Solaris, Linux

Parameters:

mAware - The mAware (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMSimple

public boolean isMSimple()
                  throws java.io.IOException,
                         AutomationException

Indicates if all the Ms are valid numbers.

Supported Platforms

Windows, Solaris, Linux

Description

MSimple is TRUE if none of the M values held by the geometry object are NaN. If any of the Ms within the object are NaN, MSimple is FALSE.

Returns:

The mSimple

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dropMs

public void dropMs()
            throws java.io.IOException,
                   AutomationException

Sets all the M values to a non-valid number (NaN).

Supported Platforms

Windows, Solaris, Linux

Description

Resets all of the current M values held by the geometry object back to NaN. MAware does not change.

Throws:

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

AutomationException - If the ArcObject component throws an exception.