com.esri.arcgis.geodatabase
Interface INetworkGlobalTurnDelayCategory

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetworkGlobalTurnDelayCategory

public interface INetworkGlobalTurnDelayCategory
extends Serializable

Provides access to members that specify the turn delay for a specified category of global turns.

Description

This interface is new at ArcGIS 9.3.

Remarks

The INetworkGlobalTurnDelayCategory interface accesses the settings of a NetworkGlobalTurnDelayCategory object, such as the road classifications, angle, and travel time for each category.

Immediately after co-creating the object, use the Initialize method to define all five properties of the category. After the category has been defined, you can modify the travel time for this category by setting the Seconds property.

Product Availability

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

Method Summary

int	getAngleCategory() The turn angle category (straight, reverse, right, or left) of turns in this turn delay category.
int	getCrossRoadCategory() The road category of the most major cross road of turns in this turn delay category.
int	getFromRoadCategory() The road category of the from road of turns in this turn delay category.
double	getSeconds() The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).
int	getToRoadCategory() The road category of the to road of turns in this turn delay category.
void	initialize(double seconds, int angleCategory, int fromRoadCategory, int toRoadCategory, int crossRoadCategory) Initializes the seconds and specifies the referenced category of global turns.
void	setSeconds(double seconds) The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).

Method Detail

initialize

void initialize(double seconds,
                int angleCategory,
                int fromRoadCategory,
                int toRoadCategory,
                int crossRoadCategory)
                throws IOException,
                       AutomationException

Initializes the seconds and specifies the referenced category of global turns.

Remarks

The FromRoadCategory and ToRoadCategory parameters can only be set to esriNRCPrimary, esriNRCSecondary, or esriNRCLocal.

Product Availability

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

Parameters:

seconds - The seconds (in)

angleCategory - A com.esri.arcgis.geodatabase.esriNetworkTurnAngleCategory constant (in)

fromRoadCategory - A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant (in)

toRoadCategory - A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant (in)

crossRoadCategory - A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeconds

double getSeconds()
                  throws IOException,
                         AutomationException

The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road categories).

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.

setSeconds

void setSeconds(double seconds)
                throws IOException,
                       AutomationException

The expected traversal time in seconds of turns associated with this turn delay category (matching angle, from road, to road, and cross road 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.

getAngleCategory

int getAngleCategory()
                     throws IOException,
                            AutomationException

The turn angle category (straight, reverse, right, or left) of turns in this turn delay category.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkTurnAngleCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromRoadCategory

int getFromRoadCategory()
                        throws IOException,
                               AutomationException

The road category of the from road of turns in this turn delay category.

Remarks

The FromRoadCategory property can only be set to esriNRCPrimary, esriNRCSecondary, or esriNRCLocal.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToRoadCategory

int getToRoadCategory()
                      throws IOException,
                             AutomationException

The road category of the to road of turns in this turn delay category.

Remarks

The ToRoadCategory property can only be set to esriNRCPrimary, esriNRCSecondary, or esriNRCLocal.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCrossRoadCategory

int getCrossRoadCategory()
                         throws IOException,
                                AutomationException

The road category of the most major cross road of turns in this turn delay category.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkRoadCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.