Class NetworkFunctionEvaluatorClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[Guid("92B433F5-556E-4A39-B674-D02213634CC4")]
[ClassInterface(ClassInterfaceType.None)]
public class NetworkFunctionEvaluatorClass : NetworkFunctionEvaluator, INetworkEvaluator, INetworkFunctionEvaluator, IGPDescribe
Inheritance
NetworkFunctionEvaluatorClass
Implements
Inherited Members

Constructors

NetworkFunctionEvaluatorClass()

public NetworkFunctionEvaluatorClass()

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.

Data

The data used by this network evaluator for custom properties.

virtual IPropertySet Data { get; set; }

Returns

IPropertySet

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.

FirstArgument

The attribute name or constant value representing the first argument of the function.

virtual object FirstArgument { get; set; }

Returns

object

Remarks

The FirstArgument must be the name of a INetworkAttribute or a constant value.

If the FirstArgument is a constant value, it should be of the same DataType for the network attribute to which this evaluator is assigned.

GetOperators(esriNetworkAttributeDataType)

Get the list of supported binary operator names.

virtual IEnumBSTR GetOperators(esriNetworkAttributeDataType returnDataType)

Parameters

returnDataType esriNetworkAttributeDataType

Returns

IEnumBSTR

Remarks

GetOperators returned the list of valid operators that can be used in a NetworkFunctionEvaluator for a given network attribute DataType.

For numeric data types, the valid operators are:

  • * (multiplication)
  • / (division)

For the Boolean data type, the valid operators are

  • < (less than)
  • <= (less than or equal)
  • > (greater than)
  • >= (greater than or equal)
  • == (equal)
  • != (not equal)

IsTimeAware()

Indicates if this evaluator supports time aware queries

virtual bool IsTimeAware()

Returns

bool

Name

Unique name of this network evaluator.

virtual string Name { get; }

Returns

string

Operator

The operator used in the function.

virtual string Operator { get; set; }

Returns

string

Remarks

The Operator must be set to one of the operators returned in GetOperators.

RequiredFieldNames

Required fields of this network evaluator.

virtual IStringArray RequiredFieldNames { get; }

Returns

IStringArray

SecondArgument

The parameter name or constant value representing the second argument of the function.

virtual object SecondArgument { get; set; }

Returns

object

Remarks

The SecondArgument must be the name of a NetworkAttributeParameter or a constant value.

If the SecondArgument is a constant value, it should be of the same DataType for the network attribute to which this evaluator is assigned.