com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class UpdateAnalysisLayerAttributeParameter

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.networkanalysttools.UpdateAnalysisLayerAttributeParameter

All Implemented Interfaces:

GPTool

public class UpdateAnalysisLayerAttributeParameter
extends AbstractGPTool

Network attributes can have parameters that can be used by its evaluators. Parameters can be used to model some dynamic aspect of an attribute's value. For example, a tunnel with a height restriction of 12 feet can be modeled using a parameter. This restriction will then evaluate to true or restricted if the vehicle is higher than 12 feet. Similarly, a bridge could have a parameter to specify a weight restriction. This tool sets or updates the network attribute parameter value for a network analysis layer. It can be used to update the value of an attribute parameter for a network analysis layer before solving it such that the solve operation uses the specified value of the attribute parameter to produce appropriate results. The Update Analysis Layer Attribute Parameter tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:

• This tool is only used for network attributes that have parameters defined on them.
• This tool can be used to repeatedly change the value of an existing parameter before solving a network analysis layer.
• This tool can be used to set parameters of type short, integer, float, double, date, boolean and string.
• If the optional value parameter is not specified then the parameter value is set to Null.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

UpdateAnalysisLayerAttributeParameter()
Creates the Update Analysis Layer Attribute Parameter tool with defaults.

UpdateAnalysisLayerAttributeParameter(Object inNetworkAnalysisLayer, String parameterizedAttribute, String attributeParameterName)
Creates the Update Analysis Layer Attribute Parameter tool with the required parameters.

Method Summary

String	getAttributeParameterName() Returns the Parameter parameter of this tool .
String	getAttributeParameterValue() Returns the Value parameter of this tool .
Object	getInNetworkAnalysisLayer() Returns the Input network analysis layer parameter of this tool .
Object	getOutputLayer() Returns the Network Analyst Layer parameter of this tool (Read only).
String	getParameterizedAttribute() Returns the Attribute parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setAttributeParameterName(String attributeParameterName) Sets the Parameter parameter of this tool .
void	setAttributeParameterValue(String attributeParameterValue) Sets the Value parameter of this tool .
void	setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer) Sets the Input network analysis layer parameter of this tool .
void	setParameterizedAttribute(String parameterizedAttribute) Sets the Attribute parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateAnalysisLayerAttributeParameter

public UpdateAnalysisLayerAttributeParameter()

Creates the Update Analysis Layer Attribute Parameter tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

UpdateAnalysisLayerAttributeParameter

public UpdateAnalysisLayerAttributeParameter(Object inNetworkAnalysisLayer,
                                             String parameterizedAttribute,
                                             String attributeParameterName)

Creates the Update Analysis Layer Attribute Parameter tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inNetworkAnalysisLayer - Network Analyst Layer, network analysis layer for which the parameter value will be updated.

parameterizedAttribute - String, the network attribute whose attribute parameter will be updated.

attributeParameterName - String, the parameter of the attribute that will be updated. Using the attribute parameter allows to model some dynamic aspect of an attribute's value.

Method Detail

getInNetworkAnalysisLayer

public Object getInNetworkAnalysisLayer()

Returns the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, network analysis layer for which the parameter value will be updated. This is a required parameter.

Returns:

the Input network analysis layer

setInNetworkAnalysisLayer

public void setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer)

Sets the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, network analysis layer for which the parameter value will be updated. This is a required parameter.

Parameters:

inNetworkAnalysisLayer - Network Analyst Layer, network analysis layer for which the parameter value will be updated.

getParameterizedAttribute

public String getParameterizedAttribute()

Returns the Attribute parameter of this tool . This parameter is String, the network attribute whose attribute parameter will be updated. This is a required parameter.

Returns:

the Attribute

setParameterizedAttribute

public void setParameterizedAttribute(String parameterizedAttribute)

Sets the Attribute parameter of this tool . This parameter is String, the network attribute whose attribute parameter will be updated. This is a required parameter.

Parameters:

parameterizedAttribute - String, the network attribute whose attribute parameter will be updated.

getAttributeParameterName

public String getAttributeParameterName()

Returns the Parameter parameter of this tool . This parameter is String, the parameter of the attribute that will be updated. Using the attribute parameter allows to model some dynamic aspect of an attribute's value. This is a required parameter.

Returns:

the Parameter

setAttributeParameterName

public void setAttributeParameterName(String attributeParameterName)

Sets the Parameter parameter of this tool . This parameter is String, the parameter of the attribute that will be updated. Using the attribute parameter allows to model some dynamic aspect of an attribute's value. This is a required parameter.

Parameters:

attributeParameterName - String, the parameter of the attribute that will be updated. Using the attribute parameter allows to model some dynamic aspect of an attribute's value.

getAttributeParameterValue

public String getAttributeParameterValue()

Returns the Value parameter of this tool . This parameter is Short, Integer, Float, Double, Date, Boolean, String, the value that will be set for the parameter of the attribute. This is an optional parameter.

Returns:

the Value

setAttributeParameterValue

public void setAttributeParameterValue(String attributeParameterValue)

Sets the Value parameter of this tool . This parameter is Short, Integer, Float, Double, Date, Boolean, String, the value that will be set for the parameter of the attribute. This is an optional parameter.

Parameters:

attributeParameterValue - Short, Integer, Float, Double, Date, Boolean, String, the value that will be set for the parameter of the attribute.

getOutputLayer

public Object getOutputLayer()

Returns the Network Analyst Layer parameter of this tool (Read only). This is an derived parameter.

Returns:

the Network Analyst Layer

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias