com.esri.arcgis.geometry
Interface IPointIDAware

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface IPointIDAware
extends Serializable

Indicator interface that identifies geometries that can have persistent point ID values attached to coordinates.

Description

Indentifies objects that can have and use PointIDs. An object will only use its PointID attributes if it is set to be Aware of them.

Product Availability

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

Method Summary

void	dropPointIDs() Unsets all PointID values without changing awareness.
boolean	isPointIDAware() Indicates whether or not the geometry is aware of and capable of handling PointIDs.
boolean	isPointIDSimple() Indicates if all PointID values for this geometry are well-defined.
void	setPointIDAware(boolean idAware) Indicates whether or not the geometry is aware of and capable of handling PointIDs.

Method Detail

isPointIDAware

boolean isPointIDAware()
                       throws IOException,
                              AutomationException

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The idAware

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointIDAware

void setPointIDAware(boolean idAware)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

idAware - The idAware (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPointIDSimple

boolean isPointIDSimple()
                        throws IOException,
                               AutomationException

Indicates if all PointID values for this geometry are well-defined. Only works if geometry is aware of PointIDs.

Description

PointIDSimple is TRUE when all of the PointIDs are well defined (not equal to 0). If any PointIDs equal 0, PointIDSimple is FALSE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The idSimple

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dropPointIDs

void dropPointIDs()
                  throws IOException,
                         AutomationException

Unsets all PointID values without changing awareness. Only works if geometry is aware of PointIDs.

Description

Resets all PointID values to there initial value of 0. PointIDAware 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.