Class NetworkGlobalTurnDelayEvaluatorClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("CE072DE5-8C43-4D4F-945B-5FCEB34A7281")]
public class NetworkGlobalTurnDelayEvaluatorClass : NetworkGlobalTurnDelayEvaluator, INetworkEvaluator, INetworkGlobalTurnDelayEvaluator, IGPDescribe
Inheritance
NetworkGlobalTurnDelayEvaluatorClass
Implements
Inherited Members

Constructors

NetworkGlobalTurnDelayEvaluatorClass()

public NetworkGlobalTurnDelayEvaluatorClass()

Explicit Interface Implementations

CacheAttribute

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

virtual bool CacheAttribute { get; }

Returns

bool

Remarks

The CacheAttribute property determines whether the values computed by this evaluator are stored in the logical network of the network dataset.

If the CacheAttribute property is set to True, then the attribute values are computed by the evaluator only when the network is built.  The computed attribute values are then stored in the logical network.  When a client queries for attribute values (such as during a network analysis), the attribute values are retrieved from the logical network.

If the CacheAttribute property is set to False, then the attribute values are computed by the evaluator whenever any client asks for an attribute value (such as during a network analysis).  The computed attribute values are not stored in the logical network.  Depending on the complexity of the evaluator, this operation can be much slower than looking up values stored in the logical network.

CustomPrimaryRoadCategoryMaxValue

Custom Primary road category maximum value.

virtual int CustomPrimaryRoadCategoryMaxValue { get; }

Returns

int

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.

CustomSecondaryRoadCategoryMaxValue

Custom Secondary road category maximum value.

virtual int CustomSecondaryRoadCategoryMaxValue { get; }

Returns

int

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.

Data

The data used by this network evaluator for custom properties.

virtual IPropertySet Data { get; set; }

Returns

IPropertySet

DefaultSeconds

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

virtual double DefaultSeconds { get; set; }

Returns

double

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.

Describe(string)

The description of the named object.

virtual object Describe(string Name)

Parameters

Name string

Returns

object

DisplayName

Name displayed in the user interface for this network evaluator.

virtual string DisplayName { get; }

Returns

string

Remarks

The DisplayName is the name for the evaluator that will be displayed in the Type column of the Evaluators dialog in ArcCatalog.

IsTimeAware()

Indicates if this evaluator supports time aware queries

virtual bool IsTimeAware()

Returns

bool

MaxReverseTurnDeflectionAngle

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

virtual int MaxReverseTurnDeflectionAngle { get; set; }

Returns

int

Remarks

The MaxReverseTurnDeflectionAngle determines whether a NetworkTurnElement 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.

MaxStraightTurnDeflectionAngle

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

virtual int MaxStraightTurnDeflectionAngle { get; set; }

Returns

int

Remarks

The MaxStraightTurnDeflectionAngle determines whether a NetworkTurnElement 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.

Name

Unique name of this network evaluator.

virtual string Name { get; }

Returns

string

RequiredFieldNames

Required fields of this network evaluator.

virtual IStringArray RequiredFieldNames { get; }

Returns

IStringArray

SetCustomRoadCategoryMaxValues(int, int)

Set custom road category maximum values.

virtual void SetCustomRoadCategoryMaxValues(int maxPrimaryRoadValue, int maxSecondaryRoadValue)

Parameters

maxPrimaryRoadValue int
maxSecondaryRoadValue int

Remarks

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

TurnDelayCategories

Array of global turn delay categories in this evaluator.

virtual IArray TurnDelayCategories { get; set; }

Returns

IArray

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.

UseCustomRoadCategoryRanges

Indicates whether to use custom road category ranges.

virtual bool UseCustomRoadCategoryRanges { get; set; }

Returns

bool

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.