com.esri.arcgis.networkanalysis
Interface INetworkLoader3

All Superinterfaces:

INetworkLoader, INetworkLoader2, Serializable

All Known Implementing Classes:

INetworkLoader3Proxy, NetworkLoader

public interface INetworkLoader3
extends INetworkLoader2, Serializable

Provides access to members that specify parameters for creating a new geometric network.

Description

The INetworkLoader3 interface contains methods and properties used for establishing and snapping features in your geometric network. Most of these methods and properties have to do with establishing connecting based on z values, in addition to the traditional x,y values. While snapping and connectivity with z values is supported during creation they are not maintained during editing. In this case; you can think of creating goemtric networks based on z values as being read-only; once they are edited; the connectivity may no longer be valid.

Product Availability

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

Method Summary

double	getDefaultSnapTolerance() Default nonzero XY cluster tolerance.
double	getDefaultZSnapTolerance() Default nonzero Z cluster tolerance.
double	getMaxSnapTolerance() Maximum nonzero XY cluster tolerance.
double	getMaxZSnapTolerance() Maximum nonzero Z cluster tolerance.
double	getMinZSnapTolerance() Minimum nonzero Z cluster tolerance.
boolean	isCanUseZs() Indicates if Z coordinates are used for snapping and connectivity.
void	setUseXYsForSnapping(boolean rhs1) Indicates if the feature classes are snapped on XY plane.
void	setUseZs(boolean rhs1) Indicates if Z coordinates are used for snapping and connectivity.
void	setZSnapTolerance(double rhs1) Snap tolerance for Z coordinates.

Methods inherited from interface com.esri.arcgis.networkanalysis.INetworkLoader2

canUseFeatureClass, checkAncillaryRoleField, checkEnabledDisabledField, getErrorTableName, getMinSnapTolerance, getNumInvalidFeatures, getTotalNumInvalidFeatures, setConfigurationKeyword, setPreserveEnabledValues

Methods inherited from interface com.esri.arcgis.networkanalysis.INetworkLoader

addFeatureClass, addWeight, addWeightAssociation, loadNetwork, putAncillaryRole, putEnabledDisabledFieldName, setFeatureDatasetNameByRef, setNetworkName, setNetworkType, setSnapTolerance

Method Detail

setUseXYsForSnapping

void setUseXYsForSnapping(boolean rhs1)
                          throws IOException,
                                 AutomationException

Indicates if the feature classes are snapped on XY plane.

Description

UseXYsForSnapping specifies whether the feature classes will be snapped in the x,y during creation. This property replaces the CanChangeGeometry paramerter on the AddFeatureClass method as of 10.0.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanUseZs

boolean isCanUseZs()
                   throws IOException,
                          AutomationException

Indicates if Z coordinates are used for snapping and connectivity.

Description

Indicates whether the geometric network will support z values. In order to be true, all feature classes in the geometric network must be z-aware.

Product Availability

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

Returns:

The canUseZs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseZs

void setUseZs(boolean rhs1)
              throws IOException,
                     AutomationException

Indicates if Z coordinates are used for snapping and connectivity.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZSnapTolerance

void setZSnapTolerance(double rhs1)
                       throws IOException,
                              AutomationException

Snap tolerance for Z coordinates.

Description

The z snap tolerance; it must be at least equal to the MinZSnapTolerance.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSnapTolerance

double getMaxSnapTolerance()
                           throws IOException,
                                  AutomationException

Maximum nonzero XY cluster tolerance.

Description

The maximum x,y snap tolerance.

Product Availability

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

Returns:

The maxSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSnapTolerance

double getDefaultSnapTolerance()
                               throws IOException,
                                      AutomationException

Default nonzero XY cluster tolerance.

Description

The default snapping tolerance for the geometric network; this is equal to the resolution of the feature dataset.

Product Availability

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

Returns:

The defaultSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinZSnapTolerance

double getMinZSnapTolerance()
                            throws IOException,
                                   AutomationException

Minimum nonzero Z cluster tolerance.

Description

The minimum z snap tolerance.

Product Availability

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

Returns:

The minZSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxZSnapTolerance

double getMaxZSnapTolerance()
                            throws IOException,
                                   AutomationException

Maximum nonzero Z cluster tolerance.

Description

The maximum z snap tolerance.

Product Availability

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

Returns:

The maxZSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultZSnapTolerance

double getDefaultZSnapTolerance()
                                throws IOException,
                                       AutomationException

Default nonzero Z cluster tolerance.

Description

The default z snap tolerance, which is equal to the default resolution of the feature dataset.

Product Availability

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

Returns:

The defaultZSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.