com.esri.arcgis.geodatabase
Interface INetworkFunctionEvaluator

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetworkFunctionEvaluator

public interface INetworkFunctionEvaluator
extends Serializable

Provides access to members that specify the properties of a function evaluator.

Description

This interface is new at ArcGIS 9.3.

Remarks

The INetworkFunctionEvaluator interface is used to access the arguments and operator assigned by this NetworkFunctionEvaluator object.

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

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

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

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

Example: Set a numeric network attribute equal to the DriveTime network attribute multiplied by 1.25.

• FirstArgument: DriveTime
• Operator: *
• SecondArgument: 1.25

Example: Set a restriction network attribute equal to True when the Vehicle Height network parameter exceeds the MaxHeight network attribute.

• FirstArgument: MaxHeight
• Operator: <
• SecondArgument: Vehicle Height

Product Availability

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

Method Summary

Object	getFirstArgument() The attribute name or constant value representing the first argument of the function.
String	getOperator() The operator used in the function.
IEnumBSTR	getOperators(int returnDataType) Get the list of supported binary operator names.
Object	getSecondArgument() The parameter name or constant value representing the second argument of the function.
void	setFirstArgument(Object arg1) The attribute name or constant value representing the first argument of the function.
void	setOperator(String op) The operator used in the function.
void	setSecondArgument(Object arg2) The parameter name or constant value representing the second argument of the function.

Method Detail

setFirstArgument

void setFirstArgument(Object arg1)
                      throws IOException,
                             AutomationException

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

Product Availability

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

Parameters:

arg1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstArgument

Object getFirstArgument()
                        throws IOException,
                               AutomationException

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

Remarks

The FirstArgument must be the name of a NetworkAttribute 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.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOperator

void setOperator(String op)
                 throws IOException,
                        AutomationException

The operator used in the function.

Product Availability

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

Parameters:

op - The op (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperator

String getOperator()
                   throws IOException,
                          AutomationException

The operator used in the function.

Remarks

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

Product Availability

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

Returns:

The op

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecondArgument

void setSecondArgument(Object arg2)
                       throws IOException,
                              AutomationException

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

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.

Product Availability

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

Parameters:

arg2 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecondArgument

Object getSecondArgument()
                         throws IOException,
                                AutomationException

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

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.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperators

IEnumBSTR getOperators(int returnDataType)
                       throws IOException,
                              AutomationException

Get the list of supported binary operator names.

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)

Product Availability

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

Parameters:

returnDataType - A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.