com.esri.arcgis.geodatabase
Interface INetworkGlobalTurnDelayEvaluator

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetworkGlobalTurnDelayEvaluator

public interface INetworkGlobalTurnDelayEvaluator
extends Serializable

Provides access to the global turn delay evaluator.

Description

This interface is new at ArcGIS 9.3.

Remarks

The INetworkGlobalTurnDelayEvaluator interface accesses the settings used by a NetworkGlobalTurnDelayEvaluator object for calculating the attribute value for a network element.

Product Availability

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

Method Summary

int	getCustomPrimaryRoadCategoryMaxValue() Custom Primary road category maximum value.
int	getCustomSecondaryRoadCategoryMaxValue() Custom Secondary road category maximum value.
double	getDefaultSeconds() Default traversal time in seconds (for undefined turn delay categories).
int	getMaxReverseTurnDeflectionAngle() The maximum deviation from a pure reverse turn to be classified as a reverse turn.
int	getMaxStraightTurnDeflectionAngle() The maximum deviation from a pure straight turn to be classified as a straight turn.
IArray	getTurnDelayCategories() Array of global turn delay categories in this evaluator.
boolean	isUseCustomRoadCategoryRanges() Indicates whether to use custom road category ranges.
void	setCustomRoadCategoryMaxValues(int maxPrimaryRoadValue, int maxSecondaryRoadValue) Set custom road category maximum values.
void	setDefaultSeconds(double seconds) Default traversal time in seconds (for undefined turn delay categories).
void	setMaxReverseTurnDeflectionAngle(int maxDeflectionAngle) The maximum deviation from a pure reverse turn to be classified as a reverse turn.
void	setMaxStraightTurnDeflectionAngle(int maxDeflectionAngle) The maximum deviation from a pure straight turn to be classified as a straight turn.
void	setTurnDelayCategoriesByRef(IArray categories) Array of global turn delay categories in this evaluator.
void	setUseCustomRoadCategoryRanges(boolean flag) Indicates whether to use custom road category ranges.

Method Detail

isUseCustomRoadCategoryRanges

boolean isUseCustomRoadCategoryRanges()
                                      throws IOException,
                                             AutomationException

Indicates whether to use custom road category ranges.

Remarks

The UseCustomRoadCategoryRanges property specifies whether to use the custom road category maximum values specified on this evaluator. If set to True, then the CustomPrimaryRoadCategoryMaxValue and CustomSecondaryRoadCategoryMaxValue properties will be used to determine whether a given road is a primary, secondary, or local road. If set to False, then the MaxValueForHierarchy values on the DENetworkDataset will be used to determine the road classification.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCustomRoadCategoryRanges

void setUseCustomRoadCategoryRanges(boolean flag)
                                    throws IOException,
                                           AutomationException

Indicates whether to use custom road category ranges.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomRoadCategoryMaxValues

void setCustomRoadCategoryMaxValues(int maxPrimaryRoadValue,
                                    int maxSecondaryRoadValue)
                                    throws IOException,
                                           AutomationException

Set custom road category maximum values.

Remarks

Use the SetCustomRoadCategoryMaxValues method to simultaneously set both the the CustomPrimaryRoadCategoryMaxValue and CustomSecondaryRoadCategoryMaxValue property values.

Product Availability

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

Parameters:

maxPrimaryRoadValue - The maxPrimaryRoadValue (in)

maxSecondaryRoadValue - The maxSecondaryRoadValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomPrimaryRoadCategoryMaxValue

int getCustomPrimaryRoadCategoryMaxValue()
                                         throws IOException,
                                                AutomationException

Custom Primary road category maximum value.

Remarks

The CustomPrimaryRoadCategoryMaxValue determines whether a road is classified as a primary road. If the AttributeValue of the HierarchyClusterAttribute is less than or equal to the CustomPrimaryRoadCategoryMaxValue, then it is a primary road.

Note that this property only takes effect if the UseCustomRoadCategoryRanges property is set to True. Otherwise, the level 1 value of MaxValueForHierarchy will be used instead.

The CustomPrimaryRoadCategoryMaxValue and CustomSecondaryRoadCategoryMaxValue are set by calling SetCustomRoadCategoryMaxValues.

Product Availability

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

Returns:

The maxValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomSecondaryRoadCategoryMaxValue

int getCustomSecondaryRoadCategoryMaxValue()
                                           throws IOException,
                                                  AutomationException

Custom Secondary road category maximum value.

Remarks

The CustomSecondaryRoadCategoryMaxValue determines whether a road is classified as a local road. If the AttributeValue of the HierarchyClusterAttribute is greater than the CustomSecondaryRoadCategoryMaxValue, then it is a local road.

Note that this property only takes effect if the UseCustomRoadCategoryRanges property is set to True. Otherwise, the level 2 value of MaxValueForHierarchy will be used instead.

The CustomPrimaryRoadCategoryMaxValue and CustomSecondaryRoadCategoryMaxValue are set by calling SetCustomRoadCategoryMaxValues.

Product Availability

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

Returns:

The maxValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSeconds

double getDefaultSeconds()
                         throws IOException,
                                AutomationException

Default traversal time in seconds (for undefined turn delay categories).

Remarks

DefaultSeconds is the travel time, in seconds, assigned to a turn that does not fall into any of the classifications defined in the TurnDelayCategories.

Product Availability

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

Returns:

The seconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultSeconds

void setDefaultSeconds(double seconds)
                       throws IOException,
                              AutomationException

Default traversal time in seconds (for undefined turn delay categories).

Product Availability

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

Parameters:

seconds - The seconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnDelayCategories

IArray getTurnDelayCategories()
                              throws IOException,
                                     AutomationException

Array of global turn delay categories in this evaluator.

Remarks

The TurnDelayCategories is an array of NetworkGlobalTurnDelayCategory objects that define the classification of turn types for this evaluator. Each category is defined by the turning angle, the road category for the starting and finishing road of the turn, and the road category for any other crossroads at that intersection. For each category, a travel time, measured in seconds, is specified.

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.

setTurnDelayCategoriesByRef

void setTurnDelayCategoriesByRef(IArray categories)
                                 throws IOException,
                                        AutomationException

Array of global turn delay categories in this evaluator.

Product Availability

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

Parameters:

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

getMaxStraightTurnDeflectionAngle

int getMaxStraightTurnDeflectionAngle()
                                      throws IOException,
                                             AutomationException

The maximum deviation from a pure straight turn to be classified as a straight turn.

Remarks

The MaxStraightTurnDeflectionAngle determines whether a NetworkTurnElement's is considered going straight, based on its Angle.

For example, if the MaxStraightTurnDeflectionAngle is set to 45, then a turn is considered going straight if its Angle is within 45 degrees of either 0 or 360 degrees (going perfectly straight) -- that is, if the angle is between 0 and 45 degrees or between 315 and 360 degrees, inclusive.

Product Availability

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

Returns:

The maxDeflectionAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxStraightTurnDeflectionAngle

void setMaxStraightTurnDeflectionAngle(int maxDeflectionAngle)
                                       throws IOException,
                                              AutomationException

The maximum deviation from a pure straight turn to be classified as a straight turn.

Product Availability

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

Parameters:

maxDeflectionAngle - The maxDeflectionAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxReverseTurnDeflectionAngle

int getMaxReverseTurnDeflectionAngle()
                                     throws IOException,
                                            AutomationException

The maximum deviation from a pure reverse turn to be classified as a reverse turn.

Remarks

The MaxReverseTurnDeflectionAngle determines whether a NetworkTurnElement's is considered going in reverse, based on its Angle.

For example, if the MaxReverseTurnDeflectionAngle is set to 30, then a turn is considered going in reverse if its Angle is within 30 degrees of 180 degrees (going exactly in reverse) -- that is, if the angle is between 150 and 210 degrees, inclusive.

Product Availability

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

Returns:

The maxDeflectionAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxReverseTurnDeflectionAngle

void setMaxReverseTurnDeflectionAngle(int maxDeflectionAngle)
                                      throws IOException,
                                             AutomationException

The maximum deviation from a pure reverse turn to be classified as a reverse turn.

Product Availability

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

Parameters:

maxDeflectionAngle - The maxDeflectionAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.