com.esri.arcgis.carto
Interface IRealTimeFeedSnap

All Superinterfaces:

Serializable

All Known Implementing Classes:

RealTimeFeedManager

public interface IRealTimeFeedSnap
extends Serializable

Provides access to properties that control the snapping behavior for the current position.

Product Availability

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

Method Summary

double	getSnapDistance() The snap distance, in map units.
IArray	getSnapLayers() The list of layers used for snapping.
boolean	isSnapToLines() Indicates if positions are snapped to the lines in the snap layers' feature geometries.
boolean	isSnapToNodes() Indicates if positions are snapped to the nodes in the snap layers' feature geometries.
boolean	isSnapToVertices() Indicates if positions are snapped to the vertices in the snap layers' feature geometries.
void	setSnapDistance(double pDistance) The snap distance, in map units.
void	setSnapLayersByRef(IArray ppArray) The list of layers used for snapping.
void	setSnapToLines(boolean pSnap) Indicates if positions are snapped to the lines in the snap layers' feature geometries.
void	setSnapToNodes(boolean pSnap) Indicates if positions are snapped to the nodes in the snap layers' feature geometries.
void	setSnapToVertices(boolean pSnap) Indicates if positions are snapped to the vertices in the snap layers' feature geometries.

Method Detail

getSnapLayers

IArray getSnapLayers()
                     throws IOException,
                            AutomationException

The list of layers used for snapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapLayersByRef

void setSnapLayersByRef(IArray ppArray)
                        throws IOException,
                               AutomationException

The list of layers used for snapping.

Product Availability

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

Parameters:

ppArray - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapDistance

double getSnapDistance()
                       throws IOException,
                              AutomationException

The snap distance, in map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapDistance

void setSnapDistance(double pDistance)
                     throws IOException,
                            AutomationException

The snap distance, in map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDistance - The pDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapToVertices

boolean isSnapToVertices()
                         throws IOException,
                                AutomationException

Indicates if positions are snapped to the vertices in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pSnap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToVertices

void setSnapToVertices(boolean pSnap)
                       throws IOException,
                              AutomationException

Indicates if positions are snapped to the vertices in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pSnap - The pSnap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapToLines

boolean isSnapToLines()
                      throws IOException,
                             AutomationException

Indicates if positions are snapped to the lines in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pSnap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToLines

void setSnapToLines(boolean pSnap)
                    throws IOException,
                           AutomationException

Indicates if positions are snapped to the lines in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pSnap - The pSnap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapToNodes

boolean isSnapToNodes()
                      throws IOException,
                             AutomationException

Indicates if positions are snapped to the nodes in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pSnap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToNodes

void setSnapToNodes(boolean pSnap)
                    throws IOException,
                           AutomationException

Indicates if positions are snapped to the nodes in the snap layers' feature geometries. Defaults to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pSnap - The pSnap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.