com.esri.arcgis.geometry
Interface IMAware

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface IMAware
extends Serializable

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

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.

Product Availability

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

See Also:

IPoint.getM(), IMSegmentation, IMSegmentation2, IMCollection, IMAware

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

boolean isMAware()
                 throws IOException,
                        AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The mAware

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMAware

void setMAware(boolean mAware)
               throws IOException,
                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mAware - The mAware (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMSimple

boolean isMSimple()
                  throws IOException,
                         AutomationException

Indicates if all the Ms are valid numbers.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The mSimple

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dropMs

void dropMs()
            throws IOException,
                   AutomationException

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

Description

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

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.