com.esri.arcgis.geoprocessing.tools.cartographytools
Class MakeGridsAndGraticulesLayer

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

public class MakeGridsAndGraticulesLayer
extends AbstractGPTool

Creates a grouped layer of feature classes depicting grid, graticule, and border features using predefined cartographic specifications. Grid layers are ideal for advanced grid definitions which are scale and extent specific. The Make Grids and Graticules Layer tool is contained in the Cartography Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeGridsAndGraticulesLayer()
          Creates the Make Grids and Graticules Layer tool with defaults.
MakeGridsAndGraticulesLayer(Object inTemplate, Object inAoi, Object inputFeatureDataset, Object outputLayer)
          Creates the Make Grids and Graticules Layer tool with the required parameters.
 
Method Summary
 Object getAncillaryCoordinateSystem1()
          Returns the Ancillary Coordinate System 1 parameter of this tool .
 Object getAncillaryCoordinateSystem2()
          Returns the Ancillary Coordinate System 2 parameter of this tool .
 Object getAncillaryCoordinateSystem3()
          Returns the Ancillary Coordinate System 3 parameter of this tool .
 Object getAncillaryCoordinateSystem4()
          Returns the Ancillary Coordinate System 4 parameter of this tool .
 String getConfigureLayout()
          Returns the Configure data frame and layout using grid settings parameter of this tool .
 Object getInAoi()
          Returns the Input Area of Interest [feature or extent] parameter of this tool .
 Object getInputFeatureDataset()
          Returns the Input Feature Dataset parameter of this tool .
 Object getInTemplate()
          Returns the Grid Template (XML file) parameter of this tool .
 Object getMaskSize()
          Returns the Mask Size parameter of this tool .
 Object getName()
          Returns the Name [value or field] parameter of this tool .
 Object getOutputLayer()
          Returns the Output Layer parameter of this tool .
 Object getPrimaryCoordinateSystem()
          Returns the Primary Coordinate System parameter of this tool .
 double getRefscale()
          Returns the Reference Scale parameter of this tool .
 double getRotation()
          Returns the Rotation 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.
 Object getXyTolerance()
          Returns the XY Tolerance parameter of this tool .
 void setAncillaryCoordinateSystem1(Object ancillaryCoordinateSystem1)
          Sets the Ancillary Coordinate System 1 parameter of this tool .
 void setAncillaryCoordinateSystem2(Object ancillaryCoordinateSystem2)
          Sets the Ancillary Coordinate System 2 parameter of this tool .
 void setAncillaryCoordinateSystem3(Object ancillaryCoordinateSystem3)
          Sets the Ancillary Coordinate System 3 parameter of this tool .
 void setAncillaryCoordinateSystem4(Object ancillaryCoordinateSystem4)
          Sets the Ancillary Coordinate System 4 parameter of this tool .
 void setConfigureLayout(String configureLayout)
          Sets the Configure data frame and layout using grid settings parameter of this tool .
 void setInAoi(Object inAoi)
          Sets the Input Area of Interest [feature or extent] parameter of this tool .
 void setInputFeatureDataset(Object inputFeatureDataset)
          Sets the Input Feature Dataset parameter of this tool .
 void setInTemplate(Object inTemplate)
          Sets the Grid Template (XML file) parameter of this tool .
 void setMaskSize(Object maskSize)
          Sets the Mask Size parameter of this tool .
 void setName(Object name)
          Sets the Name [value or field] parameter of this tool .
 void setOutputLayer(Object outputLayer)
          Sets the Output Layer parameter of this tool .
 void setPrimaryCoordinateSystem(Object primaryCoordinateSystem)
          Sets the Primary Coordinate System parameter of this tool .
 void setRefscale(double refscale)
          Sets the Reference Scale parameter of this tool .
 void setRotation(double rotation)
          Sets the Rotation parameter of this tool .
 void setXyTolerance(Object xyTolerance)
          Sets the XY Tolerance 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

MakeGridsAndGraticulesLayer

public MakeGridsAndGraticulesLayer()
Creates the Make Grids and Graticules Layer tool with defaults.

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


MakeGridsAndGraticulesLayer

public MakeGridsAndGraticulesLayer(Object inTemplate,
                                   Object inAoi,
                                   Object inputFeatureDataset,
                                   Object outputLayer)
Creates the Make Grids and Graticules 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:
inTemplate - the XML grid definition template stores the specification's graphic properties for each grid layer. In addition to the graphic properties, which cannot be altered before execution, the definition has specific default values, exposed as parameters, that can be modified before execution. template files are located in the \ArcGIS\Desktop10.0\GridTemplates directory. Additional grid templates can be obtained and shared using the ArcGIS Resource Center. the ArcGIS Production Mapping extension provides a grid designer that allows you to create new templates as well as modify existing ones.
inAoi - the feature layer or x,y extent used to determine the extent of the grid layer created.
  • Feature layer—Indicates you can choose the layer to use for the area of interest. Only one selected feature will be used from this layer. For layers that have more than one feature, the tool will only create a grid layer based on the first feature. The first feature is based on object id. All remaining features are ignored.
  • Extent—Indicates you can use one of the following as the area of interest:
inputFeatureDataset - the feature dataset that will store the features. Grid-specific feature classes will be created if they do not already exist. If they already exist, and a grid with the same name and type as the one being created also exists, it will be overwritten. a grid with the same name and type as the one created will always be overwritten, regardless of the GP environment.
outputLayer - the grouped layer of feature classes depicting grid, graticule, and border features. Each grid layer can be composed of a mask polygon, a clip polygon, segments(line), gridlines(line), ticks(line), endpoints(point), points(point), and annotation feature classes.
Method Detail

getInTemplate

public Object getInTemplate()
Returns the Grid Template (XML file) parameter of this tool . This parameter is the XML grid definition template stores the specification's graphic properties for each grid layer. In addition to the graphic properties, which cannot be altered before execution, the definition has specific default values, exposed as parameters, that can be modified before execution. template files are located in the \ArcGIS\Desktop10.0\GridTemplates directory. Additional grid templates can be obtained and shared using the ArcGIS Resource Center. the ArcGIS Production Mapping extension provides a grid designer that allows you to create new templates as well as modify existing ones. This is a required parameter.

Returns:
the Grid Template (XML file)

setInTemplate

public void setInTemplate(Object inTemplate)
Sets the Grid Template (XML file) parameter of this tool . This parameter is the XML grid definition template stores the specification's graphic properties for each grid layer. In addition to the graphic properties, which cannot be altered before execution, the definition has specific default values, exposed as parameters, that can be modified before execution. template files are located in the \ArcGIS\Desktop10.0\GridTemplates directory. Additional grid templates can be obtained and shared using the ArcGIS Resource Center. the ArcGIS Production Mapping extension provides a grid designer that allows you to create new templates as well as modify existing ones. This is a required parameter.

Parameters:
inTemplate - the XML grid definition template stores the specification's graphic properties for each grid layer. In addition to the graphic properties, which cannot be altered before execution, the definition has specific default values, exposed as parameters, that can be modified before execution. template files are located in the \ArcGIS\Desktop10.0\GridTemplates directory. Additional grid templates can be obtained and shared using the ArcGIS Resource Center. the ArcGIS Production Mapping extension provides a grid designer that allows you to create new templates as well as modify existing ones.

getInAoi

public Object getInAoi()
Returns the Input Area of Interest [feature or extent] parameter of this tool . This parameter is the feature layer or x,y extent used to determine the extent of the grid layer created. This is a required parameter.

Returns:
the Input Area of Interest [feature or extent]

setInAoi

public void setInAoi(Object inAoi)
Sets the Input Area of Interest [feature or extent] parameter of this tool . This parameter is the feature layer or x,y extent used to determine the extent of the grid layer created. This is a required parameter.

Parameters:
inAoi - the feature layer or x,y extent used to determine the extent of the grid layer created.
  • Feature layer—Indicates you can choose the layer to use for the area of interest. Only one selected feature will be used from this layer. For layers that have more than one feature, the tool will only create a grid layer based on the first feature. The first feature is based on object id. All remaining features are ignored.
  • Extent—Indicates you can use one of the following as the area of interest:

getInputFeatureDataset

public Object getInputFeatureDataset()
Returns the Input Feature Dataset parameter of this tool . This parameter is the feature dataset that will store the features. Grid-specific feature classes will be created if they do not already exist. If they already exist, and a grid with the same name and type as the one being created also exists, it will be overwritten. a grid with the same name and type as the one created will always be overwritten, regardless of the GP environment. This is a required parameter.

Returns:
the Input Feature Dataset

setInputFeatureDataset

public void setInputFeatureDataset(Object inputFeatureDataset)
Sets the Input Feature Dataset parameter of this tool . This parameter is the feature dataset that will store the features. Grid-specific feature classes will be created if they do not already exist. If they already exist, and a grid with the same name and type as the one being created also exists, it will be overwritten. a grid with the same name and type as the one created will always be overwritten, regardless of the GP environment. This is a required parameter.

Parameters:
inputFeatureDataset - the feature dataset that will store the features. Grid-specific feature classes will be created if they do not already exist. If they already exist, and a grid with the same name and type as the one being created also exists, it will be overwritten. a grid with the same name and type as the one created will always be overwritten, regardless of the GP environment.

getOutputLayer

public Object getOutputLayer()
Returns the Output Layer parameter of this tool . This parameter is the grouped layer of feature classes depicting grid, graticule, and border features. Each grid layer can be composed of a mask polygon, a clip polygon, segments(line), gridlines(line), ticks(line), endpoints(point), points(point), and annotation feature classes. This is a required parameter.

Returns:
the Output Layer

setOutputLayer

public void setOutputLayer(Object outputLayer)
Sets the Output Layer parameter of this tool . This parameter is the grouped layer of feature classes depicting grid, graticule, and border features. Each grid layer can be composed of a mask polygon, a clip polygon, segments(line), gridlines(line), ticks(line), endpoints(point), points(point), and annotation feature classes. This is a required parameter.

Parameters:
outputLayer - the grouped layer of feature classes depicting grid, graticule, and border features. Each grid layer can be composed of a mask polygon, a clip polygon, segments(line), gridlines(line), ticks(line), endpoints(point), points(point), and annotation feature classes.

getName

public Object getName()
Returns the Name [value or field] parameter of this tool . This parameter is the name for the cartographic grid created that allows for distinction between grids that are stored in the same feature dataset and set of feature classes, expressed in one of the following formats: This is an optional parameter.

Returns:
the Name [value or field]

setName

public void setName(Object name)
Sets the Name [value or field] parameter of this tool . This parameter is the name for the cartographic grid created that allows for distinction between grids that are stored in the same feature dataset and set of feature classes, expressed in one of the following formats: This is an optional parameter.

Parameters:
name - the name for the cartographic grid created that allows for distinction between grids that are stored in the same feature dataset and set of feature classes, expressed in one of the following formats:
  • String—Enter a text string for the grid name.
  • Field—Enter a field from the feature layer. The value of the field for the selected feature is used to name the grid. An area of interest field name can be used when the Input Area of Interest parameter is defined as Feature Layer.

getRefscale

public double getRefscale()
Returns the Reference Scale parameter of this tool . This parameter is the scale at which the grid is created and should be viewed. When the reference scale from the XML grid definition file is defined as "Use Environment", the reference scale is derived in the following order: This is an optional parameter.

Returns:
the Reference Scale

setRefscale

public void setRefscale(double refscale)
Sets the Reference Scale parameter of this tool . This parameter is the scale at which the grid is created and should be viewed. When the reference scale from the XML grid definition file is defined as "Use Environment", the reference scale is derived in the following order: This is an optional parameter.

Parameters:
refscale - the scale at which the grid is created and should be viewed. When the reference scale from the XML grid definition file is defined as "Use Environment", the reference scale is derived in the following order:
  • The geoprocessing Reference Scale environment setting
  • The active data frame's reference scale
  • The active data frame's scale
  • The value from the XML grid definition file

getRotation

public double getRotation()
Returns the Rotation parameter of this tool . This parameter is the rotation angle for the grid components. Rotation is used to provide annotation that is level with the page. Unless otherwise specified, rotation is calculated using the area of interest feature. When the rotation type from the XML grid definition file is defined as "Use Environment", the rotation is derived in the following order: This is an optional parameter.

Returns:
the Rotation

setRotation

public void setRotation(double rotation)
Sets the Rotation parameter of this tool . This parameter is the rotation angle for the grid components. Rotation is used to provide annotation that is level with the page. Unless otherwise specified, rotation is calculated using the area of interest feature. When the rotation type from the XML grid definition file is defined as "Use Environment", the rotation is derived in the following order: This is an optional parameter.

Parameters:
rotation - the rotation angle for the grid components. Rotation is used to provide annotation that is level with the page. Unless otherwise specified, rotation is calculated using the area of interest feature. When the rotation type from the XML grid definition file is defined as "Use Environment", the rotation is derived in the following order:
  • The active data frame's rotation
  • The value from the XML grid definition file

getMaskSize

public Object getMaskSize()
Returns the Mask Size parameter of this tool . This parameter is the mask is a polygon feature that forms an outer ring around the extent of the neatline and is used to mask data that falls in the area reserved for coordinate labels. Mask size defines the width of the polygon mask feature in map or page units. The data frame may have to be resized to fit around the edge of the mask while including the coordinate labels. This is an optional parameter.

Returns:
the Mask Size

setMaskSize

public void setMaskSize(Object maskSize)
Sets the Mask Size parameter of this tool . This parameter is the mask is a polygon feature that forms an outer ring around the extent of the neatline and is used to mask data that falls in the area reserved for coordinate labels. Mask size defines the width of the polygon mask feature in map or page units. The data frame may have to be resized to fit around the edge of the mask while including the coordinate labels. This is an optional parameter.

Parameters:
maskSize - the mask is a polygon feature that forms an outer ring around the extent of the neatline and is used to mask data that falls in the area reserved for coordinate labels. Mask size defines the width of the polygon mask feature in map or page units. The data frame may have to be resized to fit around the edge of the mask while including the coordinate labels.

getXyTolerance

public Object getXyTolerance()
Returns the XY Tolerance parameter of this tool . This parameter is the minimum tolerated distance between geodatabase features, expressed in linear units. This value is defaulted from the value set in the XML. you can set the value higher for data with less coordinate accuracy and lower for data with extremely high accuracy. Features that fall within the set XY tolerance will be considered coincident. This is an optional parameter.

Returns:
the XY Tolerance

setXyTolerance

public void setXyTolerance(Object xyTolerance)
Sets the XY Tolerance parameter of this tool . This parameter is the minimum tolerated distance between geodatabase features, expressed in linear units. This value is defaulted from the value set in the XML. you can set the value higher for data with less coordinate accuracy and lower for data with extremely high accuracy. Features that fall within the set XY tolerance will be considered coincident. This is an optional parameter.

Parameters:
xyTolerance - the minimum tolerated distance between geodatabase features, expressed in linear units. This value is defaulted from the value set in the XML. you can set the value higher for data with less coordinate accuracy and lower for data with extremely high accuracy. Features that fall within the set XY tolerance will be considered coincident.

getPrimaryCoordinateSystem

public Object getPrimaryCoordinateSystem()
Returns the Primary Coordinate System parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the primary coordinate system for the grid layer being created. Typically, it will be the coordinate system of the final product or data frame. This coordinate system must be a projected coordinate system. This is an optional parameter.

Returns:
the Primary Coordinate System

setPrimaryCoordinateSystem

public void setPrimaryCoordinateSystem(Object primaryCoordinateSystem)
Sets the Primary Coordinate System parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the primary coordinate system for the grid layer being created. Typically, it will be the coordinate system of the final product or data frame. This coordinate system must be a projected coordinate system. This is an optional parameter.

Parameters:
primaryCoordinateSystem - the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the primary coordinate system for the grid layer being created. Typically, it will be the coordinate system of the final product or data frame. This coordinate system must be a projected coordinate system.

getConfigureLayout

public String getConfigureLayout()
Returns the Configure data frame and layout using grid settings parameter of this tool . This parameter is adjusts the data frame settings to ensure they match the grid layer. The data frame's coordinate system, scale, rotation, size, extent, and clipping may be altered to enforce consistency. This setting is only available when the tool is executed from ArcMap's layout view and is not being run in the background. The default is to have this check box unchecked. This is an optional parameter.

Returns:
the Configure data frame and layout using grid settings

setConfigureLayout

public void setConfigureLayout(String configureLayout)
Sets the Configure data frame and layout using grid settings parameter of this tool . This parameter is adjusts the data frame settings to ensure they match the grid layer. The data frame's coordinate system, scale, rotation, size, extent, and clipping may be altered to enforce consistency. This setting is only available when the tool is executed from ArcMap's layout view and is not being run in the background. The default is to have this check box unchecked. This is an optional parameter.

Parameters:
configureLayout - adjusts the data frame settings to ensure they match the grid layer. The data frame's coordinate system, scale, rotation, size, extent, and clipping may be altered to enforce consistency. This setting is only available when the tool is executed from ArcMap's layout view and is not being run in the background. The default is to have this check box unchecked.

getAncillaryCoordinateSystem1

public Object getAncillaryCoordinateSystem1()
Returns the Ancillary Coordinate System 1 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinate system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the first ancillary coordinate system. This is an optional parameter.

Returns:
the Ancillary Coordinate System 1

setAncillaryCoordinateSystem1

public void setAncillaryCoordinateSystem1(Object ancillaryCoordinateSystem1)
Sets the Ancillary Coordinate System 1 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinate system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the first ancillary coordinate system. This is an optional parameter.

Parameters:
ancillaryCoordinateSystem1 - the grid template XML file creates grid components depicting coordinates or locations for a primary coordinate system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the first ancillary coordinate system.

getAncillaryCoordinateSystem2

public Object getAncillaryCoordinateSystem2()
Returns the Ancillary Coordinate System 2 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the second ancillary coordinate system. This is an optional parameter.

Returns:
the Ancillary Coordinate System 2

setAncillaryCoordinateSystem2

public void setAncillaryCoordinateSystem2(Object ancillaryCoordinateSystem2)
Sets the Ancillary Coordinate System 2 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the second ancillary coordinate system. This is an optional parameter.

Parameters:
ancillaryCoordinateSystem2 - the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the second ancillary coordinate system.

getAncillaryCoordinateSystem3

public Object getAncillaryCoordinateSystem3()
Returns the Ancillary Coordinate System 3 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the third ancillary coordinate system. This is an optional parameter.

Returns:
the Ancillary Coordinate System 3

setAncillaryCoordinateSystem3

public void setAncillaryCoordinateSystem3(Object ancillaryCoordinateSystem3)
Sets the Ancillary Coordinate System 3 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the third ancillary coordinate system. This is an optional parameter.

Parameters:
ancillaryCoordinateSystem3 - the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the third ancillary coordinate system.

getAncillaryCoordinateSystem4

public Object getAncillaryCoordinateSystem4()
Returns the Ancillary Coordinate System 4 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the fourth ancillary coordinate system. This is an optional parameter.

Returns:
the Ancillary Coordinate System 4

setAncillaryCoordinateSystem4

public void setAncillaryCoordinateSystem4(Object ancillaryCoordinateSystem4)
Sets the Ancillary Coordinate System 4 parameter of this tool . This parameter is the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the fourth ancillary coordinate system. This is an optional parameter.

Parameters:
ancillaryCoordinateSystem4 - the grid template XML file creates grid components depicting coordinates or locations for a primary coordinates system and up to four ancillary coordinate systems. The number of ancillary grids is specified by the file. You cannot add or delete ancillary coordinate systems. All coordinate systems specified must share a common geographic coordinate system. If you want to change the primary coordinate system to one that uses a different datum than the default, say for example you change the coordinate system from one that uses WGS 1984 to one that uses NAD 1983, you must change each default ancillary coordinate systems to NAD 1983 as well. this is the fourth ancillary coordinate system.

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