com.esri.arcgis.geodatabase
Interface INetworkDirections

All Superinterfaces:
Serializable
All Known Implementing Classes:
NetworkDirections

public interface INetworkDirections
extends Serializable

Provides access to the properties for setting up driving directions.

Remarks

The INetworkDirections interface should be used to get and set Directions information at the network dataset level, such as the output length units or length attribute to be used for Directions generation. In order to generate directions a network dataset needs certain information which includes:

The length attribute and units parameters are set on the INetworkDirections interface.

Product Availability

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


Method Summary
 int getDefaultOutputLengthUnits()
          The default length units that will be used for reporting distances in driving directions.
 String getLengthAttributeName()
          The name of the network attribute to be used for reporting travel distances.
 String getRoadClassAttributeName()
          The name of the network attribute to be used for road classification.
 String getTimeAttributeName()
          The name of the network attribute to be used for reporting travel time.
 void setDefaultOutputLengthUnits(int units)
          The default length units that will be used for reporting distances in driving directions.
 void setLengthAttributeName(String name)
          The name of the network attribute to be used for reporting travel distances.
 void setRoadClassAttributeName(String name)
          The name of the network attribute to be used for road classification.
 void setTimeAttributeName(String name)
          The name of the network attribute to be used for reporting travel time.
 

Method Detail

getDefaultOutputLengthUnits

int getDefaultOutputLengthUnits()
                                throws IOException,
                                       AutomationException
The default length units that will be used for reporting distances in driving directions.

Remarks

The DefaultOutputLengthUnits that will be used for generating directions. This property is required for Direction generation.

The valid values are: esriNAUMiles, esriNAUKilometers, esriNAUMeters, esriNAUYards, and esriNAUFeet from the esriNetworkAttributeUnits enumeration.

This value does not have to correspond to the units specified for the LengthAttributeName property.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputLengthUnits

void setDefaultOutputLengthUnits(int units)
                                 throws IOException,
                                        AutomationException
The default length units that will be used for reporting distances in driving directions.

Product Availability

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

Parameters:
units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

String getLengthAttributeName()
                              throws IOException,
                                     AutomationException
The name of the network attribute to be used for reporting travel distances.

Remarks

The LengthAttributeName property is the attribute that will be used for distance measurements. The attribute must have a units value from the esriNetworkAttributeUnits enumeration that corresponds to a distance measurement and must be a Cost attribute. This does not have to be same value as specified in the DefaultOutputLengthUnits property. This property is required for Direction generation.

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.

setLengthAttributeName

void setLengthAttributeName(String name)
                            throws IOException,
                                   AutomationException
The name of the network attribute to be used for reporting travel distances.

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.

getTimeAttributeName

String getTimeAttributeName()
                            throws IOException,
                                   AutomationException
The name of the network attribute to be used for reporting travel time.

Remarks

The TimeAttributeName property is the attribute that will be used for time measurements. The attribute must have a units value from the esriNetworkAttributeUnits enumeration that corresponds to a unit of time and must be a Cost attribute.

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.

setTimeAttributeName

void setTimeAttributeName(String name)
                          throws IOException,
                                 AutomationException
The name of the network attribute to be used for reporting travel time.

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.

getRoadClassAttributeName

String getRoadClassAttributeName()
                                 throws IOException,
                                        AutomationException
The name of the network attribute to be used for road classification.

Remarks

The RoadClassAttributeName property is the attribute that will be used for identifying different classes of roads in direction generation. The attribute must be of usage type: esriNAUTDescriptor and of data type: esriNADTInteger.

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.

setRoadClassAttributeName

void setRoadClassAttributeName(String name)
                               throws IOException,
                                      AutomationException
The name of the network attribute to be used for road classification.

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.