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

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

public class MakeNetCDFFeatureLayer
extends AbstractGPTool

Makes an in-memory feature layer from a netCDF file. The Make NetCDF Feature 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
MakeNetCDFFeatureLayer()
          Creates the Make NetCDF Feature Layer tool with defaults.
MakeNetCDFFeatureLayer(Object inNetCDFFile, Object variable, String xVariable, String yVariable, Object outFeatureLayer)
          Creates the Make NetCDF Feature Layer tool with the required parameters.
 
Method Summary
 Object getDimensionValues()
          Returns the Dimension Values parameter of this tool .
 Object getInNetCDFFile()
          Returns the Input netCDF File parameter of this tool .
 String getMVariable()
          Returns the M Variable parameter of this tool .
 Object getOutFeatureLayer()
          Returns the Output Feature Layer parameter of this tool .
 Object getRowDimension()
          Returns the Row Dimensions 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 .
 Object getVariable()
          Returns the Variables parameter of this tool .
 String getXVariable()
          Returns the X Variable parameter of this tool .
 String getYVariable()
          Returns the Y Variable parameter of this tool .
 String getZVariable()
          Returns the Z Variable 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 setMVariable(String mVariable)
          Sets the M Variable parameter of this tool .
 void setOutFeatureLayer(Object outFeatureLayer)
          Sets the Output Feature Layer parameter of this tool .
 void setRowDimension(Object rowDimension)
          Sets the Row Dimensions parameter of this tool .
 void setValueSelectionMethod(String valueSelectionMethod)
          Sets the Value Selection Method parameter of this tool .
 void setVariable(Object variable)
          Sets the Variables parameter of this tool .
 void setXVariable(String xVariable)
          Sets the X Variable parameter of this tool .
 void setYVariable(String yVariable)
          Sets the Y Variable parameter of this tool .
 void setZVariable(String zVariable)
          Sets the Z Variable 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

MakeNetCDFFeatureLayer

public MakeNetCDFFeatureLayer()
Creates the Make NetCDF Feature Layer tool with defaults.

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


MakeNetCDFFeatureLayer

public MakeNetCDFFeatureLayer(Object inNetCDFFile,
                              Object variable,
                              String xVariable,
                              String yVariable,
                              Object outFeatureLayer)
Creates the Make NetCDF Feature 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 netCDF variable, or variables, that will be added as fields in the feature attribute table.
xVariable - String, a netCDF coordinate variable used to define the x, or longitude coordinates of the output layer.
yVariable - String, a netCDF coordinate variable used to define the y, or latitude coordinates of the output layer.
outFeatureLayer - Feature Layer, the name of the output feature 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 Object getVariable()
Returns the Variables parameter of this tool . This parameter is String, the netCDF variable, or variables, that will be added as fields in the feature attribute table. This is a required parameter.

Returns:
the Variables

setVariable

public void setVariable(Object variable)
Sets the Variables parameter of this tool . This parameter is String, the netCDF variable, or variables, that will be added as fields in the feature attribute table. This is a required parameter.

Parameters:
variable - String, the netCDF variable, or variables, that will be added as fields in the feature attribute table.

getXVariable

public String getXVariable()
Returns the X Variable parameter of this tool . This parameter is String, a netCDF coordinate variable used to define the x, or longitude coordinates of the output layer. This is a required parameter.

Returns:
the X Variable

setXVariable

public void setXVariable(String xVariable)
Sets the X Variable parameter of this tool . This parameter is String, a netCDF coordinate variable used to define the x, or longitude coordinates of the output layer. This is a required parameter.

Parameters:
xVariable - String, a netCDF coordinate variable used to define the x, or longitude coordinates of the output layer.

getYVariable

public String getYVariable()
Returns the Y Variable parameter of this tool . This parameter is String, a netCDF coordinate variable used to define the y, or latitude coordinates of the output layer. This is a required parameter.

Returns:
the Y Variable

setYVariable

public void setYVariable(String yVariable)
Sets the Y Variable parameter of this tool . This parameter is String, a netCDF coordinate variable used to define the y, or latitude coordinates of the output layer. This is a required parameter.

Parameters:
yVariable - String, a netCDF coordinate variable used to define the y, or latitude coordinates of the output layer.

getOutFeatureLayer

public Object getOutFeatureLayer()
Returns the Output Feature Layer parameter of this tool . This parameter is Feature Layer, the name of the output feature layer. This is a required parameter.

Returns:
the Output Feature Layer

setOutFeatureLayer

public void setOutFeatureLayer(Object outFeatureLayer)
Sets the Output Feature Layer parameter of this tool . This parameter is Feature Layer, the name of the output feature layer. This is a required parameter.

Parameters:
outFeatureLayer - Feature Layer, the name of the output feature layer.

getRowDimension

public Object getRowDimension()
Returns the Row Dimensions parameter of this tool . This parameter is String, for instance, if StationID is a dimension in the netCDF file and has 10 values, by setting StationID as the dimension to use, 10 features will be created (10 rows will be created in the feature layer's attribute table). If StationID and time are used, and there are 3 time slices, 30 features will be created (30 rows will be created in the feature layer's attribute table). If you will be animating the netCDF feature layer, it is recommended, for efficiency reasons, to not set time as a row dimension. Time will still be available as a dimension that you can set to animate through, but the attribute table will not store this information. This is an optional parameter.

Returns:
the Row Dimensions

setRowDimension

public void setRowDimension(Object rowDimension)
Sets the Row Dimensions parameter of this tool . This parameter is String, for instance, if StationID is a dimension in the netCDF file and has 10 values, by setting StationID as the dimension to use, 10 features will be created (10 rows will be created in the feature layer's attribute table). If StationID and time are used, and there are 3 time slices, 30 features will be created (30 rows will be created in the feature layer's attribute table). If you will be animating the netCDF feature layer, it is recommended, for efficiency reasons, to not set time as a row dimension. Time will still be available as a dimension that you can set to animate through, but the attribute table will not store this information. This is an optional parameter.

Parameters:
rowDimension - String, for instance, if StationID is a dimension in the netCDF file and has 10 values, by setting StationID as the dimension to use, 10 features will be created (10 rows will be created in the feature layer's attribute table). If StationID and time are used, and there are 3 time slices, 30 features will be created (30 rows will be created in the feature layer's attribute table). If you will be animating the netCDF feature layer, it is recommended, for efficiency reasons, to not set time as a row dimension. Time will still be available as a dimension that you can set to animate through, but the attribute table will not store this information.

getZVariable

public String getZVariable()
Returns the Z Variable parameter of this tool . This parameter is String, a netCDF variable used to specify elevation values (z-values) for features. This is an optional parameter.

Returns:
the Z Variable

setZVariable

public void setZVariable(String zVariable)
Sets the Z Variable parameter of this tool . This parameter is String, a netCDF variable used to specify elevation values (z-values) for features. This is an optional parameter.

Parameters:
zVariable - String, a netCDF variable used to specify elevation values (z-values) for features.

getMVariable

public String getMVariable()
Returns the M Variable parameter of this tool . This parameter is String, a netCDF variable used to specify linear measurement values (m-values) for features. This is an optional parameter.

Returns:
the M Variable

setMVariable

public void setMVariable(String mVariable)
Sets the M Variable parameter of this tool . This parameter is String, a netCDF variable used to specify linear measurement values (m-values) for features. This is an optional parameter.

Parameters:
mVariable - String, a netCDF variable used to specify linear measurement values (m-values) for features.

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