com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CreateRandomPoints

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

public class CreateRandomPoints
extends AbstractGPTool

This tool is available with an ArcView or ArcEditor license, if the Spatial Analyst extension or the 3D Analyst extension is installed. Creates a user specified number of random points in an extent, in the polygons of a feature class or along the lines of a feature class. The Create Random Points tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateRandomPoints()
          Creates the Create Random Points tool with defaults.
CreateRandomPoints(Object outPath, String outName)
          Creates the Create Random Points tool with the required parameters.
 
Method Summary
 Object getConstrainingExtent()
          Returns the Constraining Extent parameter of this tool .
 Object getConstrainingFeatureClass()
          Returns the Constraining Feature Class parameter of this tool .
 String getCreateMultipointOutput()
          Returns the Create Multipoint Output parameter of this tool .
 Object getMinimumAllowedDistance()
          Returns the Minimum Allowed Distance [value or field] parameter of this tool .
 int getMultipointSize()
          Returns the Maximum Number of Points per Multipoint parameter of this tool .
 Object getNumberOfPointsOrField()
          Returns the Number of Points [value or field] parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool (Read only).
 String getOutName()
          Returns the Output Point Feature Class parameter of this tool .
 Object getOutPath()
          Returns the Output Location 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 setConstrainingExtent(Object constrainingExtent)
          Sets the Constraining Extent parameter of this tool .
 void setConstrainingFeatureClass(Object constrainingFeatureClass)
          Sets the Constraining Feature Class parameter of this tool .
 void setCreateMultipointOutput(String createMultipointOutput)
          Sets the Create Multipoint Output parameter of this tool .
 void setMinimumAllowedDistance(Object minimumAllowedDistance)
          Sets the Minimum Allowed Distance [value or field] parameter of this tool .
 void setMultipointSize(int multipointSize)
          Sets the Maximum Number of Points per Multipoint parameter of this tool .
 void setNumberOfPointsOrField(Object numberOfPointsOrField)
          Sets the Number of Points [value or field] parameter of this tool .
 void setOutName(String outName)
          Sets the Output Point Feature Class parameter of this tool .
 void setOutPath(Object outPath)
          Sets the Output Location 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

CreateRandomPoints

public CreateRandomPoints()
Creates the Create Random Points tool with defaults.

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


CreateRandomPoints

public CreateRandomPoints(Object outPath,
                          String outName)
Creates the Create Random Points 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:
outPath - Workspace | Raster Catalog, the ArcSDE, personal or file geodatabase, or workspace in which the output feature class will be created. This workspace must already exist.
outName - String, the name of the feature class to be created.
Method Detail

getOutPath

public Object getOutPath()
Returns the Output Location parameter of this tool . This parameter is Workspace | Raster Catalog, the ArcSDE, personal or file geodatabase, or workspace in which the output feature class will be created. This workspace must already exist. This is a required parameter.

Returns:
the Output Location

setOutPath

public void setOutPath(Object outPath)
Sets the Output Location parameter of this tool . This parameter is Workspace | Raster Catalog, the ArcSDE, personal or file geodatabase, or workspace in which the output feature class will be created. This workspace must already exist. This is a required parameter.

Parameters:
outPath - Workspace | Raster Catalog, the ArcSDE, personal or file geodatabase, or workspace in which the output feature class will be created. This workspace must already exist.

getOutName

public String getOutName()
Returns the Output Point Feature Class parameter of this tool . This parameter is String, the name of the feature class to be created. This is a required parameter.

Returns:
the Output Point Feature Class

setOutName

public void setOutName(String outName)
Sets the Output Point Feature Class parameter of this tool . This parameter is String, the name of the feature class to be created. This is a required parameter.

Parameters:
outName - String, the name of the feature class to be created.

getConstrainingFeatureClass

public Object getConstrainingFeatureClass()
Returns the Constraining Feature Class parameter of this tool . This parameter is Feature Layer, the feature class which contains the features into which the random points will be placed. If a polygon feature class is specified, points will be randomly placed into the polygons. If a line feature class is specified, points will be randomly placed along the lines. This is an optional parameter.

Returns:
the Constraining Feature Class

setConstrainingFeatureClass

public void setConstrainingFeatureClass(Object constrainingFeatureClass)
Sets the Constraining Feature Class parameter of this tool . This parameter is Feature Layer, the feature class which contains the features into which the random points will be placed. If a polygon feature class is specified, points will be randomly placed into the polygons. If a line feature class is specified, points will be randomly placed along the lines. This is an optional parameter.

Parameters:
constrainingFeatureClass - Feature Layer, the feature class which contains the features into which the random points will be placed. If a polygon feature class is specified, points will be randomly placed into the polygons. If a line feature class is specified, points will be randomly placed along the lines.

getConstrainingExtent

public Object getConstrainingExtent()
Returns the Constraining Extent parameter of this tool . This parameter is Extent, the extent into which points will be randomly placed. The extent will only be used if no constraining feature class is specified. This is an optional parameter.

Returns:
the Constraining Extent

setConstrainingExtent

public void setConstrainingExtent(Object constrainingExtent)
Sets the Constraining Extent parameter of this tool . This parameter is Extent, the extent into which points will be randomly placed. The extent will only be used if no constraining feature class is specified. This is an optional parameter.

Parameters:
constrainingExtent - Extent, the extent into which points will be randomly placed. The extent will only be used if no constraining feature class is specified.

getNumberOfPointsOrField

public Object getNumberOfPointsOrField()
Returns the Number of Points [value or field] parameter of this tool . This parameter is Field | Long, the number of points to be randomly placed. When a single number is specified, each feature in the feature class will have the same number of randomly placed points. When a field is specified, the number of randomly placed points is equal to the value of the field specified for that feature. This is an optional parameter.

Returns:
the Number of Points [value or field]

setNumberOfPointsOrField

public void setNumberOfPointsOrField(Object numberOfPointsOrField)
Sets the Number of Points [value or field] parameter of this tool . This parameter is Field | Long, the number of points to be randomly placed. When a single number is specified, each feature in the feature class will have the same number of randomly placed points. When a field is specified, the number of randomly placed points is equal to the value of the field specified for that feature. This is an optional parameter.

Parameters:
numberOfPointsOrField - Field | Long, the number of points to be randomly placed. When a single number is specified, each feature in the feature class will have the same number of randomly placed points. When a field is specified, the number of randomly placed points is equal to the value of the field specified for that feature.

getMinimumAllowedDistance

public Object getMinimumAllowedDistance()
Returns the Minimum Allowed Distance [value or field] parameter of this tool . This parameter is Field | Long, the smallest distance allowed between any two random placed points. In point pattern analysis this distance is called "inhibition distance". This is an optional parameter.

Returns:
the Minimum Allowed Distance [value or field]

setMinimumAllowedDistance

public void setMinimumAllowedDistance(Object minimumAllowedDistance)
Sets the Minimum Allowed Distance [value or field] parameter of this tool . This parameter is Field | Long, the smallest distance allowed between any two random placed points. In point pattern analysis this distance is called "inhibition distance". This is an optional parameter.

Parameters:
minimumAllowedDistance - Field | Long, the smallest distance allowed between any two random placed points. In point pattern analysis this distance is called "inhibition distance".

getCreateMultipointOutput

public String getCreateMultipointOutput()
Returns the Create Multipoint Output parameter of this tool . This is an optional parameter.

Returns:
the Create Multipoint Output

setCreateMultipointOutput

public void setCreateMultipointOutput(String createMultipointOutput)
Sets the Create Multipoint Output parameter of this tool . This is an optional parameter.

Parameters:
createMultipointOutput - null

getMultipointSize

public int getMultipointSize()
Returns the Maximum Number of Points per Multipoint parameter of this tool . This parameter is Long, if the output is of type multipoint, this parameter allows you to specify how many random points to place in each multipoint geometry. This is an optional parameter.

Returns:
the Maximum Number of Points per Multipoint

setMultipointSize

public void setMultipointSize(int multipointSize)
Sets the Maximum Number of Points per Multipoint parameter of this tool . This parameter is Long, if the output is of type multipoint, this parameter allows you to specify how many random points to place in each multipoint geometry. This is an optional parameter.

Parameters:
multipointSize - Long, if the output is of type multipoint, this parameter allows you to specify how many random points to place in each multipoint geometry.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Feature Class

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