com.esri.arcgis.geodatabase
Interface INetworkAttributeParameter

All Superinterfaces:

Serializable

All Known Subinterfaces:

INetworkAttributeParameter2

All Known Implementing Classes:

NetworkAttributeParameter

public interface INetworkAttributeParameter
extends Serializable

Provides access to members that specify the properties of a parameter of a network attribute.

Remarks

The INetworkAttributeParameter interface is used to specify the Name, DefaultValue, and Value of a parameter used by the network attribute.

The Name is the name of the parameter. This name must be unique among all of the parameters of a network attribute.

The DefaultValue property is the parameter value stored in the NetworkDataset that should be be used to initialize the Value property. The variant type of the parameter is based off the DefaultValue's variant type.

The Value property is the parameter value that should be used by the attribute and evaluators during analysis time. This is the run-time value for the parameter.

Product Availability

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

Method Summary

Object	getDefaultValue() The default value of the parameter.
String	getName() The name of the parameter.
Object	getValue() The current value of the parameter.
int	getVarType() The VARTYPE of the parameter (e.g.
void	setDefaultValue(Object value) The default value of the parameter.
void	setName(String name) The name of the parameter.
void	setValue(Object value) The current value of the parameter.
void	setVarType(int value) The VARTYPE of the parameter (e.g.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the parameter.

Remarks

The Name is the name of the parameter. This name must be unique among all of the parameters of a network attribute.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The name of the parameter.

Remarks

The Name is the name of the parameter. This name must be unique among all of the parameters of a network attribute.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

Object getDefaultValue()
                       throws IOException,
                              AutomationException

The default value of the parameter.

Remarks

The DefaultValue property is the parameter value stored in the NetworkDataset that should be be used to initialize the Value property. The variant type of the parameter is based off the DefaultValue's variant type.

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.

setDefaultValue

void setDefaultValue(Object value)
                     throws IOException,
                            AutomationException

The default value of the parameter.

Remarks

The DefaultValue property is the parameter value stored in the NetworkDataset that should be be used to initialize the Value property. The variant type of the parameter is based off the DefaultValue's variant type.

Product Availability

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

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue()
                throws IOException,
                       AutomationException

The current value of the parameter.

Remarks

The Value property is the parameter value that should be used by the attribute and evaluators during analysis time. This is the run-time value for the parameter.

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.

setValue

void setValue(Object value)
              throws IOException,
                     AutomationException

The current value of the parameter.

Remarks

The Value property is the parameter value that should be used by the attribute and evaluators during analysis time. This is the run-time value for the parameter.

Product Availability

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

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVarType

int getVarType()
               throws IOException,
                      AutomationException

The VARTYPE of the parameter (e.g. VT_I4).

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVarType

void setVarType(int value)
                throws IOException,
                       AutomationException

The VARTYPE of the parameter (e.g. VT_I4).

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.