com.esri.arcgis.geodatabase
Interface INetworkSourceDirections

All Superinterfaces:

Serializable

All Known Subinterfaces:

INetworkSourceDirections2

All Known Implementing Classes:

NetworkSourceDirections

public interface INetworkSourceDirections
extends Serializable

Provides access to the properties for generating driving directions for a specific network dataset source.

Remarks

The INetworkSourceDirections interface contains members for setting direction information at the network source level, such as the street name fields and the administrative boundary fields.

Product Availability

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

Method Summary

String	getAdminAreaFieldName() The name of the field containing the administrative area information for generating driving directions.
IShields	getShields() The directions shields settings for this source.
IArray	getStreetNameFields() The fields containing the street names used in reporting driving directions.
void	setAdminAreaFieldName(String name) The name of the field containing the administrative area information for generating driving directions.
void	setShieldsByRef(IShields shields) The directions shields settings for this source.
void	setStreetNameFieldsByRef(IArray fields) The fields containing the street names used in reporting driving directions.

Method Detail

getShields

IShields getShields()
                    throws IOException,
                           AutomationException

The directions shields settings for this source.

Remarks

The Shields property takes in an IShields object that contains the Shields information for each network source.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IShields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShieldsByRef

void setShieldsByRef(IShields shields)
                     throws IOException,
                            AutomationException

The directions shields settings for this source.

Product Availability

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

Parameters:

shields - A reference to a com.esri.arcgis.geodatabase.IShields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAdminAreaFieldName

String getAdminAreaFieldName()
                             throws IOException,
                                    AutomationException

The name of the field containing the administrative area information for generating driving directions.

Remarks

The AdminAreaFieldName property takes in a field name pointing to a field that contains information on moving from one region to another. For example, a network source may have a field called "States" that lists which state each feature is in. When directions are generated, this field can be used for indicating when the network analysis result crosses from one region into another.

Only one AdminAreaFieldName can be specified for each network source.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdminAreaFieldName

void setAdminAreaFieldName(String name)
                           throws IOException,
                                  AutomationException

The name of the field containing the administrative area information for generating driving directions.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreetNameFields

IArray getStreetNameFields()
                           throws IOException,
                                  AutomationException

The fields containing the street names used in reporting driving directions.

Remarks

The StreetNameFields property takes in an IArray object that contains one to many IStreetNameFields objects. This property allows the specification of a primary name and many alternate names for edge sources.

Product Availability

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

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.

setStreetNameFieldsByRef

void setStreetNameFieldsByRef(IArray fields)
                              throws IOException,
                                     AutomationException

The fields containing the street names used in reporting driving directions.

Product Availability

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

Parameters:

fields - 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.