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

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

public class MakeRouteLayer
extends AbstractGPTool

Makes a route network analysis layer and sets its navigation properties. The Make Route 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
MakeRouteLayer()
          Creates the Make Route Layer tool with defaults.
MakeRouteLayer(Object inNetworkDataset, String outNetworkAnalysisLayer, String impedanceAttribute)
          Creates the Make Route Layer tool with the required parameters.
 
Method Summary
 Object getAccumulateAttributeName()
          Returns the Accumulators parameter of this tool .
 String getFindBestOrder()
          Returns the Reorder stops to find optimal route parameter of this tool .
 String getHierarchy()
          Returns the Use hierarchy in analysis parameter of this tool .
 Object getHierarchySettings()
          Returns the Hierarchy rank settings 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 getOrderingType()
          Returns the Preserve ordering of stops 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 getOutputPathShape()
          Returns the Output path shape parameter of this tool .
 Object getRestrictionAttributeName()
          Returns the Restrictions parameter of this tool .
 Object getStartDateTime()
          Returns the Start Time parameter of this tool .
 String getTimeWindows()
          Returns the Use time windows 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 getUTurnPolicy()
          Returns the U-turn policy parameter of this tool .
 void setAccumulateAttributeName(Object accumulateAttributeName)
          Sets the Accumulators parameter of this tool .
 void setFindBestOrder(String findBestOrder)
          Sets the Reorder stops to find optimal route parameter of this tool .
 void setHierarchy(String hierarchy)
          Sets the Use hierarchy in analysis parameter of this tool .
 void setHierarchySettings(Object hierarchySettings)
          Sets the Hierarchy rank settings 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 setOrderingType(String orderingType)
          Sets the Preserve ordering of stops parameter of this tool .
 void setOutNetworkAnalysisLayer(String outNetworkAnalysisLayer)
          Sets the Output layer name parameter of this tool .
 void setOutputPathShape(String outputPathShape)
          Sets the Output path shape parameter of this tool .
 void setRestrictionAttributeName(Object restrictionAttributeName)
          Sets the Restrictions parameter of this tool .
 void setStartDateTime(Object startDateTime)
          Sets the Start Time parameter of this tool .
 void setTimeWindows(String timeWindows)
          Sets the Use time windows 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

MakeRouteLayer

public MakeRouteLayer()
Creates the Make Route Layer tool with defaults.

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


MakeRouteLayer

public MakeRouteLayer(Object inNetworkDataset,
                      String outNetworkAnalysisLayer,
                      String impedanceAttribute)
Creates the Make Route 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 route analysis will be performed.
outNetworkAnalysisLayer - String, name of the route 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 route 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 route analysis will be performed. This is a required parameter.

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

getOutNetworkAnalysisLayer

public String getOutNetworkAnalysisLayer()
Returns the Output layer name parameter of this tool . This parameter is String, name of the route 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 route network analysis layer being created. This is a required parameter.

Parameters:
outNetworkAnalysisLayer - String, name of the route 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.

getFindBestOrder

public String getFindBestOrder()
Returns the Reorder stops to find optimal route parameter of this tool . This parameter is String, specifies whether or not to reorder stops to find optimal routes. This is an optional parameter.

Returns:
the Reorder stops to find optimal route

setFindBestOrder

public void setFindBestOrder(String findBestOrder)
Sets the Reorder stops to find optimal route parameter of this tool . This parameter is String, specifies whether or not to reorder stops to find optimal routes. This is an optional parameter.

Parameters:
findBestOrder - String, specifies whether or not to reorder stops to find optimal routes.

getOrderingType

public String getOrderingType()
Returns the Preserve ordering of stops parameter of this tool . This parameter is String, this parameter affects the ordering of stops when FIND_BEST_ORDER is used. This is an optional parameter.

Returns:
the Preserve ordering of stops

setOrderingType

public void setOrderingType(String orderingType)
Sets the Preserve ordering of stops parameter of this tool . This parameter is String, this parameter affects the ordering of stops when FIND_BEST_ORDER is used. This is an optional parameter.

Parameters:
orderingType - String, this parameter affects the ordering of stops when FIND_BEST_ORDER is used.

getTimeWindows

public String getTimeWindows()
Returns the Use time windows parameter of this tool . This parameter is String, specifies if time windows will be used at the stops. This is an optional parameter.

Returns:
the Use time windows

setTimeWindows

public void setTimeWindows(String timeWindows)
Sets the Use time windows parameter of this tool . This parameter is String, specifies if time windows will be used at the stops. This is an optional parameter.

Parameters:
timeWindows - String, specifies if time windows will be used at the stops.

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.

getHierarchy

public String getHierarchy()
Returns the Use hierarchy in analysis parameter of this tool . This parameter is String, specifieswhether or not to use a hierarchy in the analysis. This is an optional parameter.

Returns:
the Use hierarchy in analysis

setHierarchy

public void setHierarchy(String hierarchy)
Sets the Use hierarchy in analysis parameter of this tool . This parameter is String, specifieswhether or not to use a hierarchy in the analysis. This is an optional parameter.

Parameters:
hierarchy - String, specifieswhether or not to use a hierarchy in the analysis.

getHierarchySettings

public Object getHierarchySettings()
Returns the Hierarchy rank settings parameter of this tool . This parameter is Network Analyst Hierarchy Settings, sets the hierarchy attribute values at which the navigation algorithm should form the highest, middle, and lowest ranks. The value is specified as a space-separated string containing two integers whose values must be greater than zero. The integers indicate low-to-mid and mid-to-high break values. The two integers must have their values in increasing order. For example, a value of "6 8" indicates that the primary roads are defined by the values of one to six, secondary roads by seven, and local roads by eight and higher. This is an optional parameter.

Returns:
the Hierarchy rank settings

setHierarchySettings

public void setHierarchySettings(Object hierarchySettings)
Sets the Hierarchy rank settings parameter of this tool . This parameter is Network Analyst Hierarchy Settings, sets the hierarchy attribute values at which the navigation algorithm should form the highest, middle, and lowest ranks. The value is specified as a space-separated string containing two integers whose values must be greater than zero. The integers indicate low-to-mid and mid-to-high break values. The two integers must have their values in increasing order. For example, a value of "6 8" indicates that the primary roads are defined by the values of one to six, secondary roads by seven, and local roads by eight and higher. This is an optional parameter.

Parameters:
hierarchySettings - Network Analyst Hierarchy Settings, sets the hierarchy attribute values at which the navigation algorithm should form the highest, middle, and lowest ranks. The value is specified as a space-separated string containing two integers whose values must be greater than zero. The integers indicate low-to-mid and mid-to-high break values. The two integers must have their values in increasing order. For example, a value of "6 8" indicates that the primary roads are defined by the values of one to six, secondary roads by seven, and local roads by eight and higher.

getOutputPathShape

public String getOutputPathShape()
Returns the Output path shape parameter of this tool . This parameter is String, in some situations, it may not be possible to compute the measures, and the lines will be output without measures. This is an optional parameter.

Returns:
the Output path shape

setOutputPathShape

public void setOutputPathShape(String outputPathShape)
Sets the Output path shape parameter of this tool . This parameter is String, in some situations, it may not be possible to compute the measures, and the lines will be output without measures. This is an optional parameter.

Parameters:
outputPathShape - String, in some situations, it may not be possible to compute the measures, and the lines will be output without measures.

getStartDateTime

public Object getStartDateTime()
Returns the Start Time parameter of this tool . This parameter is Date, a route can be assigned a start date and time. This option is available only when a time based cost attribute has been selected to solve the route. This start time is used to specify when the route starts. After the solve, the start and end time of the route are populated in the output routes. These start and end times are also used when directions are generated. By default, the start time is 8:00 AM. A date and time can be specified as 10/21/05 10:30 AM. If the route spans multiple days, then the current date is used if it has not been specified. This is an optional parameter.

Returns:
the Start Time

setStartDateTime

public void setStartDateTime(Object startDateTime)
Sets the Start Time parameter of this tool . This parameter is Date, a route can be assigned a start date and time. This option is available only when a time based cost attribute has been selected to solve the route. This start time is used to specify when the route starts. After the solve, the start and end time of the route are populated in the output routes. These start and end times are also used when directions are generated. By default, the start time is 8:00 AM. A date and time can be specified as 10/21/05 10:30 AM. If the route spans multiple days, then the current date is used if it has not been specified. This is an optional parameter.

Parameters:
startDateTime - Date, a route can be assigned a start date and time. This option is available only when a time based cost attribute has been selected to solve the route. This start time is used to specify when the route starts. After the solve, the start and end time of the route are populated in the output routes. These start and end times are also used when directions are generated. By default, the start time is 8:00 AM. A date and time can be specified as 10/21/05 10:30 AM. If the route spans multiple days, then the current date is used if it has not been specified.

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