com.esri.arcgis.geometry
Interface IGridTransformation

All Superinterfaces:
IGeoTransformation, ITransformation, Serializable
All Known Implementing Classes:
HARNTransformation, NADCONTransformation, NTv2Transformation

public interface IGridTransformation
extends IGeoTransformation, Serializable

Provides access to members that control the dataset name for a grid-based transformation.

Description

The IGridTransformation interface defines the parameters for a grid-based geographic (datum) transformation method. Currently, the NADCON and HARN (HPGN) methods for the United States are supported. The only parameter is the grid location and name.

Two functions are supported: Load and Unload. The transformation grids can range in size from 2-500 KB and are very expensive to access. The Load function places the requested grid into memory which greatly improves performance. Unload releases the memory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getGridDatasetName()
          The name of a dataset containing gridded transformation values for a geographic area.
 void load()
          Makes the grid data available for transformation operations.
 void setGridDatasetName(String datasetName)
          The name of a dataset containing gridded transformation values for a geographic area.
 void unload()
          Releases any resources consumed by the grid data.
 
Methods inherited from interface com.esri.arcgis.geometry.IGeoTransformation
getName, getSpatialReferences, putSpatialReferences, setName
 
Methods inherited from interface com.esri.arcgis.geometry.ITransformation
transformMeasuresFF, transformMeasuresFI, transformMeasuresIF, transformMeasuresII, transformPointsFF, transformPointsFI, transformPointsIF, transformPointsII
 

Method Detail

setGridDatasetName

void setGridDatasetName(String datasetName)
                        throws IOException,
                               AutomationException
The name of a dataset containing gridded transformation values for a geographic area.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
datasetName - The datasetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridDatasetName

String getGridDatasetName()
                          throws IOException,
                                 AutomationException
The name of a dataset containing gridded transformation values for a geographic area.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The datasetName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

void load()
          throws IOException,
                 AutomationException
Makes the grid data available for transformation operations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unload

void unload()
            throws IOException,
                   AutomationException
Releases any resources consumed by the grid data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.