com.esri.arcgis.networkanalysis
Interface INetworkLoader2

All Superinterfaces:

INetworkLoader, Serializable

All Known Subinterfaces:

INetworkLoader3

All Known Implementing Classes:

INetworkLoader2Proxy, INetworkLoader3Proxy, NetworkLoader

public interface INetworkLoader2
extends INetworkLoader, Serializable

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

Remarks

The INetworkLoader and INetworkLoader2 interfaces provide parameters for building your new geometric network. For more information on how to use these interfaces together in the NetworkLoader object, see the help for the NetworkLoader object.

When To Use

Use the INetworkLoader and INetworkLoader2 interfaces when you want to create a new geometric network.

Product Availability

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

Method Summary

int	canUseFeatureClass(String featureClassName) Determines if the given feature class can participate in a network.
int	checkAncillaryRoleField(String featureClassName, String fieldName) Determines whether the given AncillaryRole field is valid.
int	checkEnabledDisabledField(String featureClassName, String fieldName) Determines whether the given Enabled field is valid.
String	getErrorTableName() Name of the table containing errors encountered while building the new geometric network.
double	getMinSnapTolerance() Minimum nonzero snap tolerance for creating a new geometric network.
int	getNumInvalidFeatures(String featureClassName) Number of features with invalid geometry in the given feature class.
int	getTotalNumInvalidFeatures() Total number of features with invalid geometry.
void	setConfigurationKeyword(String rhs1) Configuration keyword for the new geometric network.
void	setPreserveEnabledValues(boolean rhs1) Indicates if the Network Loader should preserve the values in the existing Enabled fields.

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

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

Method Detail

setConfigurationKeyword

void setConfigurationKeyword(String rhs1)
                             throws IOException,
                                    AutomationException

Configuration keyword for the new geometric network.

Remarks

If the feature dataset set at INetworkLoader::FeatureDatasetName is a member of an SDE geodatabase, then you may specify a configuration keyword for building your geometric network. A configuration keyword is used to specify storage and location parameters for optimal space and disk location efficiency.

The configurationKeywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface at ArcGIS release 8.1 or later. For more information on configuration keywords, refer to the ArcSDE documentation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinSnapTolerance

double getMinSnapTolerance()
                           throws IOException,
                                  AutomationException

Minimum nonzero snap tolerance for creating a new geometric network.

Remarks

MinSnapTolerance is the minimum snap tolerance allowed for creating a geometric network in this feature dataset. To set the snap tolerance for building the network, see INetworkLoader::SnapTolerance.

MinSnapTolerance can only be called after the INetworkLoader::FeatureDatasetName property has been set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pMinSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canUseFeatureClass

int canUseFeatureClass(String featureClassName)
                       throws IOException,
                              AutomationException

Determines if the given feature class can participate in a network.

Remarks

CanUseFeatureClass can only be called after the INetworkLoader::FeatureDatasetName property has been set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

featureClassName - The featureClassName (in)

Returns:

A com.esri.arcgis.networkanalysis.esriNetworkLoaderFeatureClassCheck constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkEnabledDisabledField

int checkEnabledDisabledField(String featureClassName,
                              String fieldName)
                              throws IOException,
                                     AutomationException

Determines whether the given Enabled field is valid.

Remarks

CheckEnabledDisabledField can only be called after the INetworkLoader::FeatureDatasetName property has been set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

featureClassName - The featureClassName (in)

fieldName - The fieldName (in)

Returns:

A com.esri.arcgis.networkanalysis.esriNetworkLoaderFieldCheck constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkAncillaryRoleField

int checkAncillaryRoleField(String featureClassName,
                            String fieldName)
                            throws IOException,
                                   AutomationException

Determines whether the given AncillaryRole field is valid.

Remarks

CheckAncillaryRoleField can only be called after the INetworkLoader::FeatureDatasetName property has been set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

featureClassName - The featureClassName (in)

fieldName - The fieldName (in)

Returns:

A com.esri.arcgis.networkanalysis.esriNetworkLoaderFieldCheck constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPreserveEnabledValues

void setPreserveEnabledValues(boolean rhs1)
                              throws IOException,
                                     AutomationException

Indicates if the Network Loader should preserve the values in the existing Enabled fields.

Remarks

If an existing field is specified as the enabled/disabled field for any feature class (see PutEnabledDisabledFieldName), then the PreserveEnabledValues property will determine which features are enabled and which are disabled when the network is built.

If PreserveEnabledValues is set to False, then the current values in the enabled/disabled fields will be disregarded and overwritten with the value of True. The geometric network will be built with all its elements initially enabled.

If PreserveEnabledValues is set to True, then the valid values in the enabled/disabled fields will be preserved. Values in the enabled/disabled fields are valid if they have a value of either 0 (False) or 1 (True). Other values are invalid and will be overwritten with the value of 1 (True). After the network is built, each network feature will be either enabled or disabled, based on the value in the enabled/disabled field.

The default value of the PreserveEnabledValues property is false. If the value is not explicitely set as True, all values in the enabled field will be overwritten with True.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorTableName

String getErrorTableName()
                         throws IOException,
                                AutomationException

Name of the table containing errors encountered while building the new geometric network.

Remarks

ErrorTableName can only be called after the INetworkLoader::LoadNetwork method has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pErrorTableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalNumInvalidFeatures

int getTotalNumInvalidFeatures()
                               throws IOException,
                                      AutomationException

Total number of features with invalid geometry.

Remarks

TotalNumInvalidFeatures can only be called after the INetworkLoader::LoadNetwork method has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pTotalNumInvalidFeatures

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumInvalidFeatures

int getNumInvalidFeatures(String featureClassName)
                          throws IOException,
                                 AutomationException

Number of features with invalid geometry in the given feature class.

Product Availability

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

Parameters:

featureClassName - The featureClassName (in)

Returns:

The pNumInvalidFeatures

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.