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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.networkanalysttools.MakeServiceAreaLayer
All Implemented Interfaces:
GPTool

public class MakeServiceAreaLayer
extends AbstractGPTool

Makes a service area network analysis layer and sets its navigation properties. The Make Service Area Layer tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeServiceAreaLayer()
          Creates the Make Service Area Layer tool with defaults.
MakeServiceAreaLayer(Object inNetworkDataset, String outNetworkAnalysisLayer, String impedanceAttribute)
          Creates the Make Service Area Layer tool with the required parameters.
 
Method Summary
 Object getAccumulateAttributeName()
          Returns the Accumulators parameter of this tool .
 String getDefaultBreakValues()
          Returns the Default break values parameter of this tool .
 Object getExcludedSourceName()
          Returns the Exclude sources from polygon generation parameter of this tool .
 String getImpedanceAttribute()
          Returns the Impedance attribute parameter of this tool .
 Object getInNetworkDataset()
          Returns the Input analysis network parameter of this tool .
 String getLinesSourceFields()
          Returns the Include network source fields in lines parameter of this tool .
 String getLineType()
          Returns the Line type parameter of this tool .
 String getMerge()
          Returns the Merge polygons with similar ranges parameter of this tool .
 String getNestingType()
          Returns the Polygon nest option parameter of this tool .
 String getOutNetworkAnalysisLayer()
          Returns the Output layer name parameter of this tool .
 Object getOutputLayer()
          Returns the Network Analyst Layer parameter of this tool (Read only).
 String getOverlap()
          Returns the Overlap lines parameter of this tool .
 String getPolygonTrim()
          Returns the Trim Polygons parameter of this tool .
 String getPolygonType()
          Returns the Polygon type parameter of this tool .
 Object getPolyTrimValue()
          Returns the Polygon trim parameter of this tool .
 Object getRestrictionAttributeName()
          Returns the Restrictions parameter of this tool .
 String getSplit()
          Returns the Split lines when they cross a service area break 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.
 String getTravelFromTo()
          Returns the Travel from or to facility parameter of this tool .
 String getUTurnPolicy()
          Returns the U-turn policy parameter of this tool .
 void setAccumulateAttributeName(Object accumulateAttributeName)
          Sets the Accumulators parameter of this tool .
 void setDefaultBreakValues(String defaultBreakValues)
          Sets the Default break values parameter of this tool .
 void setExcludedSourceName(Object excludedSourceName)
          Sets the Exclude sources from polygon generation parameter of this tool .
 void setImpedanceAttribute(String impedanceAttribute)
          Sets the Impedance attribute parameter of this tool .
 void setInNetworkDataset(Object inNetworkDataset)
          Sets the Input analysis network parameter of this tool .
 void setLinesSourceFields(String linesSourceFields)
          Sets the Include network source fields in lines parameter of this tool .
 void setLineType(String lineType)
          Sets the Line type parameter of this tool .
 void setMerge(String merge)
          Sets the Merge polygons with similar ranges parameter of this tool .
 void setNestingType(String nestingType)
          Sets the Polygon nest option parameter of this tool .
 void setOutNetworkAnalysisLayer(String outNetworkAnalysisLayer)
          Sets the Output layer name parameter of this tool .
 void setOverlap(String overlap)
          Sets the Overlap lines parameter of this tool .
 void setPolygonTrim(String polygonTrim)
          Sets the Trim Polygons parameter of this tool .
 void setPolygonType(String polygonType)
          Sets the Polygon type parameter of this tool .
 void setPolyTrimValue(Object polyTrimValue)
          Sets the Polygon trim parameter of this tool .
 void setRestrictionAttributeName(Object restrictionAttributeName)
          Sets the Restrictions parameter of this tool .
 void setSplit(String split)
          Sets the Split lines when they cross a service area break parameter of this tool .
 void setTravelFromTo(String travelFromTo)
          Sets the Travel from or to facility parameter of this tool .
 void setUTurnPolicy(String uTurnPolicy)
          Sets the U-turn policy 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

MakeServiceAreaLayer

public MakeServiceAreaLayer()
Creates the Make Service Area Layer tool with defaults.

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


MakeServiceAreaLayer

public MakeServiceAreaLayer(Object inNetworkDataset,
                            String outNetworkAnalysisLayer,
                            String impedanceAttribute)
Creates the Make Service Area Layer 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:
inNetworkDataset - Network Dataset Layer, the network dataset on which the service area analysis will be performed.
outNetworkAnalysisLayer - String, name of the service area network analysis layer being created.
impedanceAttribute - String, the cost attribute to be used as impedance in the analysis.
Method Detail

getInNetworkDataset

public Object getInNetworkDataset()
Returns the Input analysis network parameter of this tool . This parameter is Network Dataset Layer, the network dataset on which the service area analysis will be performed. This is a required parameter.

Returns:
the Input analysis network

setInNetworkDataset

public void setInNetworkDataset(Object inNetworkDataset)
Sets the Input analysis network parameter of this tool . This parameter is Network Dataset Layer, the network dataset on which the service area analysis will be performed. This is a required parameter.

Parameters:
inNetworkDataset - Network Dataset Layer, the network dataset on which the service area analysis will be performed.

getOutNetworkAnalysisLayer

public String getOutNetworkAnalysisLayer()
Returns the Output layer name parameter of this tool . This parameter is String, name of the service area network analysis layer being created. This is a required parameter.

Returns:
the Output layer name

setOutNetworkAnalysisLayer

public void setOutNetworkAnalysisLayer(String outNetworkAnalysisLayer)
Sets the Output layer name parameter of this tool . This parameter is String, name of the service area network analysis layer being created. This is a required parameter.

Parameters:
outNetworkAnalysisLayer - String, name of the service area network analysis layer being created.

getImpedanceAttribute

public String getImpedanceAttribute()
Returns the Impedance attribute parameter of this tool . This parameter is String, the cost attribute to be used as impedance in the analysis. This is a required parameter.

Returns:
the Impedance attribute

setImpedanceAttribute

public void setImpedanceAttribute(String impedanceAttribute)
Sets the Impedance attribute parameter of this tool . This parameter is String, the cost attribute to be used as impedance in the analysis. This is a required parameter.

Parameters:
impedanceAttribute - String, the cost attribute to be used as impedance in the analysis.

getTravelFromTo

public String getTravelFromTo()
Returns the Travel from or to facility parameter of this tool . This parameter is String, specifies the direction to or from facilities. This is an optional parameter.

Returns:
the Travel from or to facility

setTravelFromTo

public void setTravelFromTo(String travelFromTo)
Sets the Travel from or to facility parameter of this tool . This parameter is String, specifies the direction to or from facilities. This is an optional parameter.

Parameters:
travelFromTo - String, specifies the direction to or from facilities.

getDefaultBreakValues

public String getDefaultBreakValues()
Returns the Default break values parameter of this tool . This parameter is String, default impedance values at which to break the service area polygons. The default can be overridden by the value of for the facility. This is an optional parameter.

Returns:
the Default break values

setDefaultBreakValues

public void setDefaultBreakValues(String defaultBreakValues)
Sets the Default break values parameter of this tool . This parameter is String, default impedance values at which to break the service area polygons. The default can be overridden by the value of for the facility. This is an optional parameter.

Parameters:
defaultBreakValues - String, default impedance values at which to break the service area polygons. The default can be overridden by the value of for the facility.

getPolygonType

public String getPolygonType()
Returns the Polygon type parameter of this tool . This parameter is String, specifies the type of polygon to be generated. This is an optional parameter.

Returns:
the Polygon type

setPolygonType

public void setPolygonType(String polygonType)
Sets the Polygon type parameter of this tool . This parameter is String, specifies the type of polygon to be generated. This is an optional parameter.

Parameters:
polygonType - String, specifies the type of polygon to be generated.

getMerge

public String getMerge()
Returns the Merge polygons with similar ranges parameter of this tool . This parameter is String, specifies if polygons should be merged if they share similar ranges. This is an optional parameter.

Returns:
the Merge polygons with similar ranges

setMerge

public void setMerge(String merge)
Sets the Merge polygons with similar ranges parameter of this tool . This parameter is String, specifies if polygons should be merged if they share similar ranges. This is an optional parameter.

Parameters:
merge - String, specifies if polygons should be merged if they share similar ranges.

getNestingType

public String getNestingType()
Returns the Polygon nest option parameter of this tool . This parameter is String, specifies if the output should contain nested polygons. This is an optional parameter.

Returns:
the Polygon nest option

setNestingType

public void setNestingType(String nestingType)
Sets the Polygon nest option parameter of this tool . This parameter is String, specifies if the output should contain nested polygons. This is an optional parameter.

Parameters:
nestingType - String, specifies if the output should contain nested polygons.

getLineType

public String getLineType()
Returns the Line type parameter of this tool . This parameter is String, specifies the type of lines to be generated. This is an optional parameter.

Returns:
the Line type

setLineType

public void setLineType(String lineType)
Sets the Line type parameter of this tool . This parameter is String, specifies the type of lines to be generated. This is an optional parameter.

Parameters:
lineType - String, specifies the type of lines to be generated.

getOverlap

public String getOverlap()
Returns the Overlap lines parameter of this tool . This parameter is String, determines if overlap lines are generated when service area lines are computed. This is an optional parameter.

Returns:
the Overlap lines

setOverlap

public void setOverlap(String overlap)
Sets the Overlap lines parameter of this tool . This parameter is String, determines if overlap lines are generated when service area lines are computed. This is an optional parameter.

Parameters:
overlap - String, determines if overlap lines are generated when service area lines are computed.

getSplit

public String getSplit()
Returns the Split lines when they cross a service area break parameter of this tool . This parameter is String, splits lines when they cross a service area break. This is an optional parameter.

Returns:
the Split lines when they cross a service area break

setSplit

public void setSplit(String split)
Sets the Split lines when they cross a service area break parameter of this tool . This parameter is String, splits lines when they cross a service area break. This is an optional parameter.

Parameters:
split - String, splits lines when they cross a service area break.

getExcludedSourceName

public Object getExcludedSourceName()
Returns the Exclude sources from polygon generation parameter of this tool . This parameter is String, when generating the polygons, the geometry of traversed elements from the excluded sources will not be considered. Example: excluding a subway edge source from a pedestrian walk zone polygon, since it is impossible to exit the subway along an edge. This is an optional parameter.

Returns:
the Exclude sources from polygon generation

setExcludedSourceName

public void setExcludedSourceName(Object excludedSourceName)
Sets the Exclude sources from polygon generation parameter of this tool . This parameter is String, when generating the polygons, the geometry of traversed elements from the excluded sources will not be considered. Example: excluding a subway edge source from a pedestrian walk zone polygon, since it is impossible to exit the subway along an edge. This is an optional parameter.

Parameters:
excludedSourceName - String, when generating the polygons, the geometry of traversed elements from the excluded sources will not be considered. Example: excluding a subway edge source from a pedestrian walk zone polygon, since it is impossible to exit the subway along an edge.

getAccumulateAttributeName

public Object getAccumulateAttributeName()
Returns the Accumulators parameter of this tool . This parameter is String, list of cost attributes to be accumulated during analysis. This is an optional parameter.

Returns:
the Accumulators

setAccumulateAttributeName

public void setAccumulateAttributeName(Object accumulateAttributeName)
Sets the Accumulators parameter of this tool . This parameter is String, list of cost attributes to be accumulated during analysis. This is an optional parameter.

Parameters:
accumulateAttributeName - String, list of cost attributes to be accumulated during analysis.

getUTurnPolicy

public String getUTurnPolicy()
Returns the U-turn policy parameter of this tool . This parameter is String, specifies optional U-turn restrictions. This is an optional parameter.

Returns:
the U-turn policy

setUTurnPolicy

public void setUTurnPolicy(String uTurnPolicy)
Sets the U-turn policy parameter of this tool . This parameter is String, specifies optional U-turn restrictions. This is an optional parameter.

Parameters:
uTurnPolicy - String, specifies optional U-turn restrictions.

getRestrictionAttributeName

public Object getRestrictionAttributeName()
Returns the Restrictions parameter of this tool . This parameter is String, list of restriction attributes to be honored during analysis. This is an optional parameter.

Returns:
the Restrictions

setRestrictionAttributeName

public void setRestrictionAttributeName(Object restrictionAttributeName)
Sets the Restrictions parameter of this tool . This parameter is String, list of restriction attributes to be honored during analysis. This is an optional parameter.

Parameters:
restrictionAttributeName - String, list of restriction attributes to be honored during analysis.

getPolygonTrim

public String getPolygonTrim()
Returns the Trim Polygons parameter of this tool . This parameter is , specifies that the polygons will be trimmed further. This is an optional parameter.

Returns:
the Trim Polygons

setPolygonTrim

public void setPolygonTrim(String polygonTrim)
Sets the Trim Polygons parameter of this tool . This parameter is , specifies that the polygons will be trimmed further. This is an optional parameter.

Parameters:
polygonTrim - , specifies that the polygons will be trimmed further.

getPolyTrimValue

public Object getPolyTrimValue()
Returns the Polygon trim parameter of this tool . This parameter is Linear unit, the polygon trim value is used to trim the service area polygon. The parameter includes a value and units for the value. The default value is 100 meters. This value is used if the Trim_Polys option is used. This is an optional parameter.

Returns:
the Polygon trim

setPolyTrimValue

public void setPolyTrimValue(Object polyTrimValue)
Sets the Polygon trim parameter of this tool . This parameter is Linear unit, the polygon trim value is used to trim the service area polygon. The parameter includes a value and units for the value. The default value is 100 meters. This value is used if the Trim_Polys option is used. This is an optional parameter.

Parameters:
polyTrimValue - Linear unit, the polygon trim value is used to trim the service area polygon. The parameter includes a value and units for the value. The default value is 100 meters. This value is used if the Trim_Polys option is used.

getLinesSourceFields

public String getLinesSourceFields()
Returns the Include network source fields in lines parameter of this tool . This parameter is String, determines if overlap lines are generated when service area lines are computed. This is an optional parameter.

Returns:
the Include network source fields in lines

setLinesSourceFields

public void setLinesSourceFields(String linesSourceFields)
Sets the Include network source fields in lines parameter of this tool . This parameter is String, determines if overlap lines are generated when service area lines are computed. This is an optional parameter.

Parameters:
linesSourceFields - String, determines if overlap lines are generated when service area lines are computed.

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