com.esri.arcgis.networkanalyst
Interface IGPNAHierarchySettings

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPNAHierarchySettings

public interface IGPNAHierarchySettings
extends Serializable

Provides access to properties/methods of the network analyst hierarchy settings object.

Remarks

NAHierarchySettings specify if a particular network analyst solver should use a hierarchy. For example, the route, closest facility, OD matrix, and VRP solvers can use hierarchy if it is present in the network. The hierarchy can be used to solve quickly on large networks by modifying the shortest path solver to look at the road hierarchy and favor the higher level roads to reach the destination. This interface specifies how the values stored in a hierarchy attribute are mapped to the solver needs.

Product Availability

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

Method Summary

int	getMaxValueForHierarchy(int level) The maximum value for a hierarchy level.
IGPMessage	initialize(IDENetworkDataset network) Initialize hierarchy levels based on defaults found in the network.
void	setMaxValueForHierarchy(int level, int value) The maximum value for a hierarchy level.

Method Detail

setMaxValueForHierarchy

void setMaxValueForHierarchy(int level,
                             int value)
                             throws IOException,
                                    AutomationException

The maximum value for a hierarchy level.

Product Availability

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

Parameters:

level - The level (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxValueForHierarchy

int getMaxValueForHierarchy(int level)
                            throws IOException,
                                   AutomationException

The maximum value for a hierarchy level.

Product Availability

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

Parameters:

level - The level (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

IGPMessage initialize(IDENetworkDataset network)
                      throws IOException,
                             AutomationException

Initialize hierarchy levels based on defaults found in the network.

Product Availability

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

Parameters:

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.