com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class ChangeTerrainReferenceScale

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

public class ChangeTerrainReferenceScale
extends AbstractGPTool

Changes the reference scale used by a terrain pyramid level. The Change Terrain Reference Scale tool is contained in the 3D Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ChangeTerrainReferenceScale()
          Creates the Change Terrain Reference Scale tool with defaults.
ChangeTerrainReferenceScale(Object inTerrain, int oldRefscale, int newRefscale)
          Creates the Change Terrain Reference Scale tool with the required parameters.
 
Method Summary
 Object getDerivedOutTerrain()
          Returns the Output Terrain parameter of this tool (Read only).
 Object getInTerrain()
          Returns the Input Terrain parameter of this tool .
 int getNewRefscale()
          Returns the New Reference Scale parameter of this tool .
 int getOldRefscale()
          Returns the Old Reference Scale 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 setInTerrain(Object inTerrain)
          Sets the Input Terrain parameter of this tool .
 void setNewRefscale(int newRefscale)
          Sets the New Reference Scale parameter of this tool .
 void setOldRefscale(int oldRefscale)
          Sets the Old Reference Scale 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

ChangeTerrainReferenceScale

public ChangeTerrainReferenceScale()
Creates the Change Terrain Reference Scale tool with defaults.

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


ChangeTerrainReferenceScale

public ChangeTerrainReferenceScale(Object inTerrain,
                                   int oldRefscale,
                                   int newRefscale)
Creates the Change Terrain Reference Scale 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:
inTerrain - Terrain Layer, the input terrain dataset.
oldRefscale - Long, the reference scale of an existing pyramid level.
newRefscale - Long, the new reference scale for the pyramid level.
Method Detail

getInTerrain

public Object getInTerrain()
Returns the Input Terrain parameter of this tool . This parameter is Terrain Layer, the input terrain dataset. This is a required parameter.

Returns:
the Input Terrain

setInTerrain

public void setInTerrain(Object inTerrain)
Sets the Input Terrain parameter of this tool . This parameter is Terrain Layer, the input terrain dataset. This is a required parameter.

Parameters:
inTerrain - Terrain Layer, the input terrain dataset.

getOldRefscale

public int getOldRefscale()
Returns the Old Reference Scale parameter of this tool . This parameter is Long, the reference scale of an existing pyramid level. This is a required parameter.

Returns:
the Old Reference Scale

setOldRefscale

public void setOldRefscale(int oldRefscale)
Sets the Old Reference Scale parameter of this tool . This parameter is Long, the reference scale of an existing pyramid level. This is a required parameter.

Parameters:
oldRefscale - Long, the reference scale of an existing pyramid level.

getNewRefscale

public int getNewRefscale()
Returns the New Reference Scale parameter of this tool . This parameter is Long, the new reference scale for the pyramid level. This is a required parameter.

Returns:
the New Reference Scale

setNewRefscale

public void setNewRefscale(int newRefscale)
Sets the New Reference Scale parameter of this tool . This parameter is Long, the new reference scale for the pyramid level. This is a required parameter.

Parameters:
newRefscale - Long, the new reference scale for the pyramid level.

getDerivedOutTerrain

public Object getDerivedOutTerrain()
Returns the Output Terrain parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Terrain

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