com.esri.arcgis.geoprocessing.tools.multidimensiontools
Class MakeNetCDFRasterLayer

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

public class MakeNetCDFRasterLayer
extends AbstractGPTool

Makes an in-memory raster layer from a netCDF file. The Make NetCDF Raster Layer tool is contained in the Multidimension Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeNetCDFRasterLayer()
          Creates the Make NetCDF Raster Layer tool with defaults.
MakeNetCDFRasterLayer(Object inNetCDFFile, String variable, String xDimension, String yDimension, Object outRasterLayer)
          Creates the Make NetCDF Raster Layer tool with the required parameters.
 
Method Summary
 String getBandDimension()
          Returns the Band Dimension parameter of this tool .
 Object getDimensionValues()
          Returns the Dimension Values parameter of this tool .
 Object getInNetCDFFile()
          Returns the Input netCDF File parameter of this tool .
 Object getOutRasterLayer()
          Returns the Output Raster Layer 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 getValueSelectionMethod()
          Returns the Value Selection Method parameter of this tool .
 String getVariable()
          Returns the Variable parameter of this tool .
 String getXDimension()
          Returns the X Dimension parameter of this tool .
 String getYDimension()
          Returns the Y Dimension parameter of this tool .
 void setBandDimension(String bandDimension)
          Sets the Band Dimension parameter of this tool .
 void setDimensionValues(Object dimensionValues)
          Sets the Dimension Values parameter of this tool .
 void setInNetCDFFile(Object inNetCDFFile)
          Sets the Input netCDF File parameter of this tool .
 void setOutRasterLayer(Object outRasterLayer)
          Sets the Output Raster Layer parameter of this tool .
 void setValueSelectionMethod(String valueSelectionMethod)
          Sets the Value Selection Method parameter of this tool .
 void setVariable(String variable)
          Sets the Variable parameter of this tool .
 void setXDimension(String xDimension)
          Sets the X Dimension parameter of this tool .
 void setYDimension(String yDimension)
          Sets the Y Dimension 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

MakeNetCDFRasterLayer

public MakeNetCDFRasterLayer()
Creates the Make NetCDF Raster Layer tool with defaults.

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


MakeNetCDFRasterLayer

public MakeNetCDFRasterLayer(Object inNetCDFFile,
                             String variable,
                             String xDimension,
                             String yDimension,
                             Object outRasterLayer)
Creates the Make NetCDF Raster 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:
inNetCDFFile - null
variable - String, the variable of the netCDF file used to assign cell values to the output raster. This is the variable that will be displayed, such as temperature or rainfall.
xDimension - String, a netCDF dimension used to define the x, or longitude coordinates of the output layer.
yDimension - String, a netCDF dimension used to define the y, or latitude coordinates of the output layer.
outRasterLayer - Raster Layer, the name of the output raster layer.
Method Detail

getInNetCDFFile

public Object getInNetCDFFile()
Returns the Input netCDF File parameter of this tool . This is a required parameter.

Returns:
the Input netCDF File

setInNetCDFFile

public void setInNetCDFFile(Object inNetCDFFile)
Sets the Input netCDF File parameter of this tool . This is a required parameter.

Parameters:
inNetCDFFile - null

getVariable

public String getVariable()
Returns the Variable parameter of this tool . This parameter is String, the variable of the netCDF file used to assign cell values to the output raster. This is the variable that will be displayed, such as temperature or rainfall. This is a required parameter.

Returns:
the Variable

setVariable

public void setVariable(String variable)
Sets the Variable parameter of this tool . This parameter is String, the variable of the netCDF file used to assign cell values to the output raster. This is the variable that will be displayed, such as temperature or rainfall. This is a required parameter.

Parameters:
variable - String, the variable of the netCDF file used to assign cell values to the output raster. This is the variable that will be displayed, such as temperature or rainfall.

getXDimension

public String getXDimension()
Returns the X Dimension parameter of this tool . This parameter is String, a netCDF dimension used to define the x, or longitude coordinates of the output layer. This is a required parameter.

Returns:
the X Dimension

setXDimension

public void setXDimension(String xDimension)
Sets the X Dimension parameter of this tool . This parameter is String, a netCDF dimension used to define the x, or longitude coordinates of the output layer. This is a required parameter.

Parameters:
xDimension - String, a netCDF dimension used to define the x, or longitude coordinates of the output layer.

getYDimension

public String getYDimension()
Returns the Y Dimension parameter of this tool . This parameter is String, a netCDF dimension used to define the y, or latitude coordinates of the output layer. This is a required parameter.

Returns:
the Y Dimension

setYDimension

public void setYDimension(String yDimension)
Sets the Y Dimension parameter of this tool . This parameter is String, a netCDF dimension used to define the y, or latitude coordinates of the output layer. This is a required parameter.

Parameters:
yDimension - String, a netCDF dimension used to define the y, or latitude coordinates of the output layer.

getOutRasterLayer

public Object getOutRasterLayer()
Returns the Output Raster Layer parameter of this tool . This parameter is Raster Layer, the name of the output raster layer. This is a required parameter.

Returns:
the Output Raster Layer

setOutRasterLayer

public void setOutRasterLayer(Object outRasterLayer)
Sets the Output Raster Layer parameter of this tool . This parameter is Raster Layer, the name of the output raster layer. This is a required parameter.

Parameters:
outRasterLayer - Raster Layer, the name of the output raster layer.

getBandDimension

public String getBandDimension()
Returns the Band Dimension parameter of this tool . This parameter is String, a netCDF dimension used to create bands in the output raster. Set this dimension if a multiband raster layer is required. For instance, altitude might be set as the band dimension to create a multiband raster where each band represents temperature at that altitude. This is an optional parameter.

Returns:
the Band Dimension

setBandDimension

public void setBandDimension(String bandDimension)
Sets the Band Dimension parameter of this tool . This parameter is String, a netCDF dimension used to create bands in the output raster. Set this dimension if a multiband raster layer is required. For instance, altitude might be set as the band dimension to create a multiband raster where each band represents temperature at that altitude. This is an optional parameter.

Parameters:
bandDimension - String, a netCDF dimension used to create bands in the output raster. Set this dimension if a multiband raster layer is required. For instance, altitude might be set as the band dimension to create a multiband raster where each band represents temperature at that altitude.

getDimensionValues

public Object getDimensionValues()
Returns the Dimension Values parameter of this tool . This parameter is (String String; String String;...), the value (such as 01/30/05) of the dimension (such as Time) or dimensions to use when displaying the variable in the output layer. By default, the first value of the dimension or dimensions will be used. This default value can also be altered on the netCDF tab of the Layer Properties dialog box. This is an optional parameter.

Returns:
the Dimension Values

setDimensionValues

public void setDimensionValues(Object dimensionValues)
Sets the Dimension Values parameter of this tool . This parameter is (String String; String String;...), the value (such as 01/30/05) of the dimension (such as Time) or dimensions to use when displaying the variable in the output layer. By default, the first value of the dimension or dimensions will be used. This default value can also be altered on the netCDF tab of the Layer Properties dialog box. This is an optional parameter.

Parameters:
dimensionValues - (String String; String String;...), the value (such as 01/30/05) of the dimension (such as Time) or dimensions to use when displaying the variable in the output layer. By default, the first value of the dimension or dimensions will be used. This default value can also be altered on the netCDF tab of the Layer Properties dialog box.

getValueSelectionMethod

public String getValueSelectionMethod()
Returns the Value Selection Method parameter of this tool . This parameter is String, specifies the dimension value selection method. This is an optional parameter.

Returns:
the Value Selection Method

setValueSelectionMethod

public void setValueSelectionMethod(String valueSelectionMethod)
Sets the Value Selection Method parameter of this tool . This parameter is String, specifies the dimension value selection method. This is an optional parameter.

Parameters:
valueSelectionMethod - String, specifies the dimension value selection method.

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