com.esri.arcgis.geodatabase

Class NetworkGlobalTurnDelayEvaluator

java.lang.Object

com.esri.arcgis.geodatabase.NetworkGlobalTurnDelayEvaluator

All Implemented Interfaces:

IGPDescribe, INetworkEvaluator, INetworkGlobalTurnDelayEvaluator, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class NetworkGlobalTurnDelayEvaluator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkEvaluator, INetworkGlobalTurnDelayEvaluator, IGPDescribe

COM Class 'NetworkGlobalTurnDelayEvaluator'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'A container for describing a network attribute evaluator for global turn delay whose values are specified by global turn delay settings.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.INetworkEvaluator

IID, IID0fcb88f9_8b17_4ed8_99c7_c876f5da8b7e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.INetworkGlobalTurnDelayEvaluator

IID, IID17d76a4b_1365_4e09_a4e0_9bf02dbf07b2, xxDummy

Constructor Summary

Constructors

Constructor and Description
NetworkGlobalTurnDelayEvaluator() Constructs a NetworkGlobalTurnDelayEvaluator using ArcGIS Engine.
NetworkGlobalTurnDelayEvaluator(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. NetworkGlobalTurnDelayEvaluator theNetworkGlobalTurnDelayEvaluator = (NetworkGlobalTurnDelayEvaluator) obj;

Method Summary

Modifier and Type	Method and Description
java.lang.Object	describe(java.lang.String name) The description of the named object.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
int	getCustomPrimaryRoadCategoryMaxValue() Custom Primary road category maximum value.
int	getCustomSecondaryRoadCategoryMaxValue() Custom Secondary road category maximum value.
IPropertySet	getData() The data used by this network evaluator for custom properties.
double	getDefaultSeconds() Default traversal time in seconds (for undefined turn delay categories).
java.lang.String	getDisplayName() Name displayed in the user interface for this network evaluator.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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.
java.lang.String	getName() Unique name of this network evaluator.
IStringArray	getRequiredFieldNames() Required fields of this network evaluator.
IArray	getTurnDelayCategories() Array of global turn delay categories in this evaluator.
int	hashCode() the hashcode for this object
boolean	isCacheAttribute() Indicates if this evaluator's values should be computed and stored when the network is built or computed at run time and never stored.
boolean	isTimeAware() Indicates if this evaluator supports time aware queries
boolean	isUseCustomRoadCategoryRanges() Indicates whether to use custom road category ranges.
void	release() Release this COM object reference
void	setCustomRoadCategoryMaxValues(int maxPrimaryRoadValue, int maxSecondaryRoadValue) Set custom road category maximum values.
void	setData(IPropertySet data) The data used by this network evaluator for custom properties.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkGlobalTurnDelayEvaluator

public NetworkGlobalTurnDelayEvaluator()
                                throws java.io.IOException,
                                       java.net.UnknownHostException

Constructs a NetworkGlobalTurnDelayEvaluator using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NetworkGlobalTurnDelayEvaluator

public NetworkGlobalTurnDelayEvaluator(java.lang.Object obj)
                                throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkGlobalTurnDelayEvaluator theNetworkGlobalTurnDelayEvaluator = (NetworkGlobalTurnDelayEvaluator) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Unique name of this network evaluator.

Specified by:

getName in interface INetworkEvaluator

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setData

public void setData(IPropertySet data)
             throws java.io.IOException,
                    AutomationException

The data used by this network evaluator for custom properties.

Specified by:

setData in interface INetworkEvaluator

Parameters:

data - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getData

public IPropertySet getData()
                     throws java.io.IOException,
                            AutomationException

The data used by this network evaluator for custom properties.

Specified by:

getData in interface INetworkEvaluator

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

Name displayed in the user interface for this network evaluator.

Specified by:

getDisplayName in interface INetworkEvaluator

Returns:

The pDisplayName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheAttribute

public boolean isCacheAttribute()
                         throws java.io.IOException,
                                AutomationException

Indicates if this evaluator's values should be computed and stored when the network is built or computed at run time and never stored.

Specified by:

isCacheAttribute in interface INetworkEvaluator

Returns:

The cache

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequiredFieldNames

public IStringArray getRequiredFieldNames()
                                   throws java.io.IOException,
                                          AutomationException

Required fields of this network evaluator.

Specified by:

getRequiredFieldNames in interface INetworkEvaluator

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimeAware

public boolean isTimeAware()
                    throws java.io.IOException,
                           AutomationException

Indicates if this evaluator supports time aware queries

Specified by:

isTimeAware in interface INetworkEvaluator

Returns:

The aware

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCustomRoadCategoryRanges

public boolean isUseCustomRoadCategoryRanges()
                                      throws java.io.IOException,
                                             AutomationException

Indicates whether to use custom road category ranges.

Specified by:

isUseCustomRoadCategoryRanges in interface INetworkGlobalTurnDelayEvaluator

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCustomRoadCategoryRanges

public void setUseCustomRoadCategoryRanges(boolean flag)
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether to use custom road category ranges.

Specified by:

setUseCustomRoadCategoryRanges in interface INetworkGlobalTurnDelayEvaluator

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomRoadCategoryMaxValues

public void setCustomRoadCategoryMaxValues(int maxPrimaryRoadValue,
                                           int maxSecondaryRoadValue)
                                    throws java.io.IOException,
                                           AutomationException

Set custom road category maximum values.

Specified by:

setCustomRoadCategoryMaxValues in interface INetworkGlobalTurnDelayEvaluator

Parameters:

maxPrimaryRoadValue - The maxPrimaryRoadValue (in)

maxSecondaryRoadValue - The maxSecondaryRoadValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomPrimaryRoadCategoryMaxValue

public int getCustomPrimaryRoadCategoryMaxValue()
                                         throws java.io.IOException,
                                                AutomationException

Custom Primary road category maximum value.

Specified by:

getCustomPrimaryRoadCategoryMaxValue in interface INetworkGlobalTurnDelayEvaluator

Returns:

The maxValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomSecondaryRoadCategoryMaxValue

public int getCustomSecondaryRoadCategoryMaxValue()
                                           throws java.io.IOException,
                                                  AutomationException

Custom Secondary road category maximum value.

Specified by:

getCustomSecondaryRoadCategoryMaxValue in interface INetworkGlobalTurnDelayEvaluator

Returns:

The maxValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSeconds

public double getDefaultSeconds()
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

getDefaultSeconds in interface INetworkGlobalTurnDelayEvaluator

Returns:

The seconds

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultSeconds

public void setDefaultSeconds(double seconds)
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

setDefaultSeconds in interface INetworkGlobalTurnDelayEvaluator

Parameters:

seconds - The seconds (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnDelayCategories

public IArray getTurnDelayCategories()
                              throws java.io.IOException,
                                     AutomationException

Array of global turn delay categories in this evaluator.

Specified by:

getTurnDelayCategories in interface INetworkGlobalTurnDelayEvaluator

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTurnDelayCategoriesByRef

public void setTurnDelayCategoriesByRef(IArray categories)
                                 throws java.io.IOException,
                                        AutomationException

Array of global turn delay categories in this evaluator.

Specified by:

setTurnDelayCategoriesByRef in interface INetworkGlobalTurnDelayEvaluator

Parameters:

categories - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxStraightTurnDeflectionAngle

public int getMaxStraightTurnDeflectionAngle()
                                      throws java.io.IOException,
                                             AutomationException

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

Specified by:

getMaxStraightTurnDeflectionAngle in interface INetworkGlobalTurnDelayEvaluator

Returns:

The maxDeflectionAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxStraightTurnDeflectionAngle

public void setMaxStraightTurnDeflectionAngle(int maxDeflectionAngle)
                                       throws java.io.IOException,
                                              AutomationException

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

Specified by:

setMaxStraightTurnDeflectionAngle in interface INetworkGlobalTurnDelayEvaluator

Parameters:

maxDeflectionAngle - The maxDeflectionAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxReverseTurnDeflectionAngle

public int getMaxReverseTurnDeflectionAngle()
                                     throws java.io.IOException,
                                            AutomationException

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

Specified by:

getMaxReverseTurnDeflectionAngle in interface INetworkGlobalTurnDelayEvaluator

Returns:

The maxDeflectionAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxReverseTurnDeflectionAngle

public void setMaxReverseTurnDeflectionAngle(int maxDeflectionAngle)
                                      throws java.io.IOException,
                                             AutomationException

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

Specified by:

setMaxReverseTurnDeflectionAngle in interface INetworkGlobalTurnDelayEvaluator

Parameters:

maxDeflectionAngle - The maxDeflectionAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The description of the named object.

Product Availability

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

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.