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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.multidimensiontools.FeatureToNetCDF

All Implemented Interfaces:

GPTool

public class FeatureToNetCDF
extends AbstractGPTool

Converts a point feature class to a netCDF file. The Feature to NetCDF tool is contained in the Multidimension Tools tool box.

Usage tips:

• The default variable name is the same as the input feature field name specified in the Fields to Variables parameter.
• The type of variable is the same as the type of field.
• Special fields Shape.X and Shape.Y are always available in the Fields to Variables drop-down list. They can be used for specifying variable names for x-coordinates and y-coordinates, respectively. If variable names are not specified or Shape.X and Shape.Y are not added to the list, the x- and y-coordinates are exported with default variable names. The default variable names for Shape.X and Shape.Y are lon and lat, respectively, when the feature is in a geographic coordinate system. In all other cases, the default variable names for Shape.X and Shape.Y are x and y, respectively.
• Special fields Shape.Z and Shape.M are available in the Fields to Variables drop-down list for features with Z and M values. To export Z and M values, you must add Shape.Z and Shape.M to the list. The default variable names for Shape.Z and Shape.M are z and m, respectively.
• The default dimension name is the same as the input feature field name specified in the Fields to Dimensions parameter.
• The size of a dimension is equal to the number of unique values in the respective field.
• If no field is specified as a row dimension, then a dimension RecordID is created in the output netCDF file with a size equal to the number of features.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

FeatureToNetCDF()
Creates the Feature to NetCDF tool with defaults.

FeatureToNetCDF(Object inFeatures, Object fieldsToVariables, Object outNetCDFFile)
Creates the Feature to NetCDF tool with the required parameters.

Method Summary

Object	getFieldsToDimensions() Returns the Fields to Dimensions parameter of this tool .
Object	getFieldsToVariables() Returns the Fields to Variables parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutNetCDFFile() Returns the Output netCDF File 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	setFieldsToDimensions(Object fieldsToDimensions) Sets the Fields to Dimensions parameter of this tool .
void	setFieldsToVariables(Object fieldsToVariables) Sets the Fields to Variables parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutNetCDFFile(Object outNetCDFFile) Sets the Output netCDF File 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

FeatureToNetCDF

public FeatureToNetCDF()

Creates the Feature to NetCDF tool with defaults.

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

FeatureToNetCDF

public FeatureToNetCDF(Object inFeatures,
                       Object fieldsToVariables,
                       Object outNetCDFFile)

Creates the Feature to NetCDF 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:

inFeatures - the input feature class.

fieldsToVariables - the field or fields used to create variables in the netCDF file. Four special fields—Shape.X, Shape.Y, Shape.Z, and Shape.M—can be used for exporting x-coordinates or longitude, y-coordinates or latitude, Z values, and M values of input features, respectively.

• field—A field in the input feature attribute table.
• {variable}—The netCDF variable name.
• {units}—The units of the data represented by the field.

outNetCDFFile - the output netCDF file. The filename must have a .nc extension.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature class. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input feature class. This is a required parameter.

Parameters:

inFeatures - the input feature class.

getFieldsToVariables

public Object getFieldsToVariables()

Returns the Fields to Variables parameter of this tool . This parameter is the field or fields used to create variables in the netCDF file. Four special fields—Shape.X, Shape.Y, Shape.Z, and Shape.M—can be used for exporting x-coordinates or longitude, y-coordinates or latitude, Z values, and M values of input features, respectively. This is a required parameter.

Returns:

the Fields to Variables

setFieldsToVariables

public void setFieldsToVariables(Object fieldsToVariables)

Sets the Fields to Variables parameter of this tool . This parameter is the field or fields used to create variables in the netCDF file. Four special fields—Shape.X, Shape.Y, Shape.Z, and Shape.M—can be used for exporting x-coordinates or longitude, y-coordinates or latitude, Z values, and M values of input features, respectively. This is a required parameter.

Parameters:

fieldsToVariables - the field or fields used to create variables in the netCDF file. Four special fields—Shape.X, Shape.Y, Shape.Z, and Shape.M—can be used for exporting x-coordinates or longitude, y-coordinates or latitude, Z values, and M values of input features, respectively.

• field—A field in the input feature attribute table.
• {variable}—The netCDF variable name.
• {units}—The units of the data represented by the field.

getOutNetCDFFile

public Object getOutNetCDFFile()

Returns the Output netCDF File parameter of this tool . This parameter is the output netCDF file. The filename must have a .nc extension. This is a required parameter.

Returns:

the Output netCDF File

setOutNetCDFFile

public void setOutNetCDFFile(Object outNetCDFFile)

Sets the Output netCDF File parameter of this tool . This parameter is the output netCDF file. The filename must have a .nc extension. This is a required parameter.

Parameters:

outNetCDFFile - the output netCDF file. The filename must have a .nc extension.

getFieldsToDimensions

public Object getFieldsToDimensions()

Returns the Fields to Dimensions parameter of this tool . This parameter is the field or fields used to create dimensions in the netCDF file. This is an optional parameter.

Returns:

the Fields to Dimensions

setFieldsToDimensions

public void setFieldsToDimensions(Object fieldsToDimensions)

Sets the Fields to Dimensions parameter of this tool . This parameter is the field or fields used to create dimensions in the netCDF file. This is an optional parameter.

Parameters:

fieldsToDimensions - the field or fields used to create dimensions in the netCDF file.

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