com.esri.arcgis.networkanalysis
Interface INetworkLoaderProps

All Superinterfaces:
Serializable
All Known Implementing Classes:
NetworkLoader

public interface INetworkLoaderProps
extends Serializable

Provides access to memebers that return the default names of fields and domains used by the network loader.

Remarks

When you are building a network, certain fields are required in the feature classes in which you are building your network. For example, each feature class must have an enabled/disabled field. If you specify sources/sinks, a field for the ancillary role is required. The NetworkLoader requires you to tell it what these field names are.

The default field names for these fields are accessible via the INetworkLoaderProps interface. These default field names are reserved words in the Geodatabase. It is strongly recommended that you use these default field names when calling PutAncillaryRole and PutEnabledDisabledFieldName on the INetworkLoader interface.

Even if you are using the default field names, if these fields already exist in your feature classes, it is best to check that they are of the correct domain and subtype. Use the CheckAncillaryRoleField and CheckEnabledDisabledField methods on the INetworkLoader2 interface to check these fields before Putting them on the NetworkLoader object.

When To Use

Use the INetworkLoaderProps interface to get the correct names for the fields required by INetworkLoader to build a geometric network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
INetworkLoader, INetworkLoaderProgress, INetworkLoaderProps

Method Summary
 String getDefaultAncillaryRoleDomain()
          Default ancillary role domain name.
 String getDefaultAncillaryRoleField()
          Default ancillary role field name.
 String getDefaultEnabledDomain()
          Default enabled domain name.
 String getDefaultEnabledField()
          Default enabled field name.
 

Method Detail

getDefaultEnabledDomain

String getDefaultEnabledDomain()
                               throws IOException,
                                      AutomationException
Default enabled domain name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The defaultEnabledDomain
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultEnabledField

String getDefaultEnabledField()
                              throws IOException,
                                     AutomationException
Default enabled field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The defaultEnabledField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultAncillaryRoleDomain

String getDefaultAncillaryRoleDomain()
                                     throws IOException,
                                            AutomationException
Default ancillary role domain name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The defaultAncillaryRoleDomain
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultAncillaryRoleField

String getDefaultAncillaryRoleField()
                                    throws IOException,
                                           AutomationException
Default ancillary role field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The defaultAncillaryRoleField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.