com.esri.arcgis.geodatabase
Class NetworkDirections

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetworkDirections
All Implemented Interfaces:
INetworkDirections, ISignposts, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NetworkDirections
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkDirections, ISignposts

A container for describing and using network directions.

Description

Network Datasets can have direction information associated with them in order to provide more accurate and useful analysis results. Some properties of directions, such as the output length units or length attribute, are set at the network dataset level and are specified with the INetworkDirections interface. Other properties, such as the street name fields and the administrative boundary fields, are set at the source level using the INetworkSourceDirections interface. The highway signage information is specified with the ISignposts interface.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NetworkDirections()
          Constructs a NetworkDirections using ArcGIS Engine.
NetworkDirections(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkDirections theNetworkDirections = (NetworkDirections) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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 getSignpostFeatureClassName()
          The name of the feature class containing the signposts.
 String getSignpostStreetsTableName()
          The name of the indexed table of signpost street references.
 String getTimeAttributeName()
          The name of the network attribute to be used for reporting travel time.
 int hashCode()
          the hashcode for this object
 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 setSignpostFeatureClassName(String className)
          The name of the feature class containing the signposts.
 void setSignpostStreetsTableName(String tableName)
          The name of the indexed table of signpost street references.
 void setTimeAttributeName(String name)
          The name of the network attribute to be used for reporting travel time.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

NetworkDirections

public NetworkDirections()
                  throws IOException,
                         UnknownHostException
Constructs a NetworkDirections using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

NetworkDirections

public NetworkDirections(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkDirections theNetworkDirections = (NetworkDirections) obj;

Construct a NetworkDirections using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NetworkDirections.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getDefaultOutputLengthUnits

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

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

setDefaultOutputLengthUnits

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

Specified by:
setDefaultOutputLengthUnits in interface INetworkDirections
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

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

Specified by:
getLengthAttributeName in interface INetworkDirections
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

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

Specified by:
setLengthAttributeName in interface INetworkDirections
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeAttributeName

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

Specified by:
getTimeAttributeName in interface INetworkDirections
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeAttributeName

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

Specified by:
setTimeAttributeName in interface INetworkDirections
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRoadClassAttributeName

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

Specified by:
getRoadClassAttributeName in interface INetworkDirections
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRoadClassAttributeName

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

Specified by:
setRoadClassAttributeName in interface INetworkDirections
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSignpostFeatureClassName

public String getSignpostFeatureClassName()
                                   throws IOException,
                                          AutomationException
The name of the feature class containing the signposts.

Product Availability

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

Specified by:
getSignpostFeatureClassName in interface ISignposts
Returns:
The className
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSignpostFeatureClassName

public void setSignpostFeatureClassName(String className)
                                 throws IOException,
                                        AutomationException
The name of the feature class containing the signposts.

Product Availability

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

Specified by:
setSignpostFeatureClassName in interface ISignposts
Parameters:
className - The className (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSignpostStreetsTableName

public String getSignpostStreetsTableName()
                                   throws IOException,
                                          AutomationException
The name of the indexed table of signpost street references.

Product Availability

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

Specified by:
getSignpostStreetsTableName in interface ISignposts
Returns:
The tableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSignpostStreetsTableName

public void setSignpostStreetsTableName(String tableName)
                                 throws IOException,
                                        AutomationException
The name of the indexed table of signpost street references.

Product Availability

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

Specified by:
setSignpostStreetsTableName in interface ISignposts
Parameters:
tableName - The tableName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.