com.esri.arcgis.geodatabase
Interface INetworkEvaluator

All Superinterfaces:

Serializable

All Known Subinterfaces:

INetworkEvaluator2

All Known Implementing Classes:

NetworkConstantEvaluator, NetworkEdgeTrafficEvaluator, NetworkFieldEvaluator, NetworkFunctionEvaluator, NetworkGlobalTurnDelayEvaluator, NetworkScriptEvaluator

public interface INetworkEvaluator
extends Serializable

Provides access to members that specify the properties of an attribute evaluator in a network dataset.

Superseded By

INetworkEvaluator2

Description

Network evaluators assign values to attributes in a network dataset. They are the mechanism to transfer attributes from source features to network elements.

Remarks

The INetworkEvaluator interface is used to access the properties of the network evaluator, such as its name.

To access the evaluator object for an existing evaluator assigned to a network dataset attribute, use the Evalutor or DefaultEvaluator methods on the IEvaluatedNetworkAttribute interface.

Product Availability

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

Method Summary

String	getDisplayName() Name displayed in the user interface for this network evaluator.
String	getName() Unique name of this network evaluator.
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.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Unique name of this network evaluator.

Product Availability

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

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException

Name displayed in the user interface for this network evaluator.

Remarks

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

Product Availability

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

Returns:

The pDisplayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheAttribute

boolean isCacheAttribute()
                         throws 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.

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.

Product Availability

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

Returns:

The cache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.