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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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 analysis properties. A service area analysis layer is useful in determining the area of accessibility within a given cutoff cost from a facility location. The Make Service Area Layer tool is contained in the Network Analyst Tools tool box.

Usage tips:

• After creating the analysis layer with this tool, you can add network analysis objects to it using the tool, solve the analysis using the tool, and save the results on disk using tool.
• When using this tool in geoprocessing models, if the model is run as a tool, the output network analysis layer must be made a model parameter. Otherwise the output layer is not added to the table of contents in ArcMap.

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 - the network dataset on which the service area analysis will be performed.

outNetworkAnalysisLayer - name of the service area network analysis layer to create.

impedanceAttribute - 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 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 the network dataset on which the service area analysis will be performed. This is a required parameter.

Parameters:

inNetworkDataset - 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 name of the service area network analysis layer to create. 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 name of the service area network analysis layer to create. This is a required parameter.

Parameters:

outNetworkAnalysisLayer - name of the service area network analysis layer to create.

getImpedanceAttribute

public String getImpedanceAttribute()

Returns the Impedance attribute parameter of this tool . This parameter is 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 the cost attribute to be used as impedance in the analysis. This is a required parameter.

Parameters:

impedanceAttribute - 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 specifies the direction of travel to or from the facilities. using this option can result in different service areas on a network with one-way restrictions and having different impedances based on direction of travel. The service area for a pizza delivery store, for example, should be created away from the facility, whereas the service area of a hospital should be created toward the facility. 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 specifies the direction of travel to or from the facilities. using this option can result in different service areas on a network with one-way restrictions and having different impedances based on direction of travel. The service area for a pizza delivery store, for example, should be created away from the facility, whereas the service area of a hospital should be created toward the facility. This is an optional parameter.

Parameters:

travelFromTo - specifies the direction of travel to or from the facilities. using this option can result in different service areas on a network with one-way restrictions and having different impedances based on direction of travel. The service area for a pizza delivery store, for example, should be created away from the facility, whereas the service area of a hospital should be created toward the facility.

getDefaultBreakValues

public String getDefaultBreakValues()

Returns the Default break values parameter of this tool . This parameter is default impedance values indicating the extent of the service area to be calculated. The default can be overridden by specifying the breaks value on the facilities. multiple polygon breaks can be set to create concentric service areas. For instance, to find 2-, 3-, and 5-minute service areas for the same facility, specify "2 3 5" as the value for the Default break values parameter (the numbers 2, 3, and 5 should be separated by a space). 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 default impedance values indicating the extent of the service area to be calculated. The default can be overridden by specifying the breaks value on the facilities. multiple polygon breaks can be set to create concentric service areas. For instance, to find 2-, 3-, and 5-minute service areas for the same facility, specify "2 3 5" as the value for the Default break values parameter (the numbers 2, 3, and 5 should be separated by a space). This is an optional parameter.

Parameters:

defaultBreakValues - default impedance values indicating the extent of the service area to be calculated. The default can be overridden by specifying the breaks value on the facilities. multiple polygon breaks can be set to create concentric service areas. For instance, to find 2-, 3-, and 5-minute service areas for the same facility, specify "2 3 5" as the value for the Default break values parameter (the numbers 2, 3, and 5 should be separated by a space).

getPolygonType

public String getPolygonType()

Returns the Polygon type parameter of this tool . This parameter is specifies the type of polygons to be generated. if your data is of an urban area with a gridlike network, the difference between generalized and detailed polygons would be minimal. However, for mountain and rural roads, the detailed polygons may present significantly more accurate results than generalized polygons. 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 specifies the type of polygons to be generated. if your data is of an urban area with a gridlike network, the difference between generalized and detailed polygons would be minimal. However, for mountain and rural roads, the detailed polygons may present significantly more accurate results than generalized polygons. This is an optional parameter.

Parameters:

polygonType - specifies the type of polygons to be generated. if your data is of an urban area with a gridlike network, the difference between generalized and detailed polygons would be minimal. However, for mountain and rural roads, the detailed polygons may present significantly more accurate results than generalized polygons.

getMerge

public String getMerge()

Returns the Merge polygons with similar ranges parameter of this tool . This parameter is specifies the options to merge polygons that share similar break values. This option is applicable only when generating polygons for multiple facilities. 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 specifies the options to merge polygons that share similar break values. This option is applicable only when generating polygons for multiple facilities. This is an optional parameter.

Parameters:

merge - specifies the options to merge polygons that share similar break values. This option is applicable only when generating polygons for multiple facilities.

getNestingType

public String getNestingType()

Returns the Polygon nest option parameter of this tool . This parameter is specifies the option to create concentric service area polygons as disks or rings. This option is applicable only when multiple break values are specified for the facilities. 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 specifies the option to create concentric service area polygons as disks or rings. This option is applicable only when multiple break values are specified for the facilities. This is an optional parameter.

Parameters:

nestingType - specifies the option to create concentric service area polygons as disks or rings. This option is applicable only when multiple break values are specified for the facilities.

getLineType

public String getLineType()

Returns the Line type parameter of this tool . This parameter is specifies the type of lines to be generated based on the service area analysis. Selecting the TRUE_LINES or TRUE_LINES_WITH_MEASURES option for large service areas will increase the amount of memory consumed by the analysis. 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 specifies the type of lines to be generated based on the service area analysis. Selecting the TRUE_LINES or TRUE_LINES_WITH_MEASURES option for large service areas will increase the amount of memory consumed by the analysis. This is an optional parameter.

Parameters:

lineType - specifies the type of lines to be generated based on the service area analysis. Selecting the TRUE_LINES or TRUE_LINES_WITH_MEASURES option for large service areas will increase the amount of memory consumed by the analysis.

getOverlap

public String getOverlap()

Returns the Overlap lines parameter of this tool . This parameter is determines if overlapping lines are generated when the 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 determines if overlapping lines are generated when the service area lines are computed. This is an optional parameter.

Parameters:

overlap - determines if overlapping lines are generated when the 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 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 is an optional parameter.

Parameters:

split - null

getExcludedSourceName

public Object getExcludedSourceName()

Returns the Exclude sources from polygon generation parameter of this tool . This parameter is specifies the list of network sources to be excluded when generating the polygons. The geometry of traversed elements from the excluded sources will be omitted from all polygons. this is useful if you have some network sources that you don't want to be included in the polygon generation because they create less accurate polygons or are inconsequential for the service area analysis. For example, while creating a drive time service area in a multimodal network of streets and rails, you should choose to exclude the rail lines from polygon generation so as to correctly model where a vehicle could travel. excluding a network source from service area polygons does not prevent those sources from being traversed. Excluding sources from service area polygons only influences the polygon shape of the service areas. If you want to prevent traversal of a given network source, you must create an appropriate restriction when defining your network dataset. 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 specifies the list of network sources to be excluded when generating the polygons. The geometry of traversed elements from the excluded sources will be omitted from all polygons. this is useful if you have some network sources that you don't want to be included in the polygon generation because they create less accurate polygons or are inconsequential for the service area analysis. For example, while creating a drive time service area in a multimodal network of streets and rails, you should choose to exclude the rail lines from polygon generation so as to correctly model where a vehicle could travel. excluding a network source from service area polygons does not prevent those sources from being traversed. Excluding sources from service area polygons only influences the polygon shape of the service areas. If you want to prevent traversal of a given network source, you must create an appropriate restriction when defining your network dataset. This is an optional parameter.

Parameters:

excludedSourceName - specifies the list of network sources to be excluded when generating the polygons. The geometry of traversed elements from the excluded sources will be omitted from all polygons. this is useful if you have some network sources that you don't want to be included in the polygon generation because they create less accurate polygons or are inconsequential for the service area analysis. For example, while creating a drive time service area in a multimodal network of streets and rails, you should choose to exclude the rail lines from polygon generation so as to correctly model where a vehicle could travel. excluding a network source from service area polygons does not prevent those sources from being traversed. Excluding sources from service area polygons only influences the polygon shape of the service areas. If you want to prevent traversal of a given network source, you must create an appropriate restriction when defining your network dataset.

getAccumulateAttributeName

public Object getAccumulateAttributeName()

Returns the Accumulators parameter of this tool . This parameter is list of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Impedance attribute parameter to calculate the route. for each cost attribute that is accumulated, a Total_[Impedance] property is added to the routes that are output by the solver. This is an optional parameter.

Returns:

the Accumulators

setAccumulateAttributeName

public void setAccumulateAttributeName(Object accumulateAttributeName)

Sets the Accumulators parameter of this tool . This parameter is list of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Impedance attribute parameter to calculate the route. for each cost attribute that is accumulated, a Total_[Impedance] property is added to the routes that are output by the solver. This is an optional parameter.

Parameters:

accumulateAttributeName - list of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Impedance attribute parameter to calculate the route. for each cost attribute that is accumulated, a Total_[Impedance] property is added to the routes that are output by the solver.

getUTurnPolicy

public String getUTurnPolicy()

Returns the U-turn policy parameter of this tool . This parameter is restrict or permit U-turns at junctions that could occur during network traversal between stops. 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 restrict or permit U-turns at junctions that could occur during network traversal between stops. This is an optional parameter.

Parameters:

uTurnPolicy - restrict or permit U-turns at junctions that could occur during network traversal between stops.

getRestrictionAttributeName

public Object getRestrictionAttributeName()

Returns the Restrictions parameter of this tool . This parameter is list of restriction attributes to apply during the 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 list of restriction attributes to apply during the analysis. This is an optional parameter.

Parameters:

restrictionAttributeName - list of restriction attributes to apply during the analysis.

getPolygonTrim

public String getPolygonTrim()

Returns the Trim Polygons parameter of this tool . This is an optional parameter.

Returns:

the Trim Polygons

setPolygonTrim

public void setPolygonTrim(String polygonTrim)

Sets the Trim Polygons parameter of this tool . This is an optional parameter.

Parameters:

polygonTrim - null

getPolyTrimValue

public Object getPolyTrimValue()

Returns the Polygon trim parameter of this tool . This parameter is specifies the distance within which the service area polygons are trimmed. The parameter includes a value and units for the distance. The default value is 100 meters. 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 specifies the distance within which the service area polygons are trimmed. The parameter includes a value and units for the distance. The default value is 100 meters. This is an optional parameter.

Parameters:

polyTrimValue - specifies the distance within which the service area polygons are trimmed. The parameter includes a value and units for the distance. The default value is 100 meters.

getLinesSourceFields

public String getLinesSourceFields()

Returns the Include network source fields in lines parameter of this tool . 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 is an optional parameter.

Parameters:

linesSourceFields - null

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