com.esri.arcgis.datasourcesraster
Class ApproximationXform

java.lang.Object
  com.esri.arcgis.datasourcesraster.ApproximationXform

All Implemented Interfaces:

IApproximationXform, IGeodataXform2, IGeodataXformApproximation, IRasterXform, ISensorXform, IGeodataXform, ITransformation, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class ApproximationXform
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeodataXform, IGeodataXform2, IApproximationXform, IRasterXform, ISensorXform, IGeodataXformApproximation, ITransformation, IClone, IPersistStream, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, Externalizable

A transformation that approximates other transformations.

Description

ApproximateXform is used to approximate a GeoDataXform to achieve a better performance and it is mainly used for those GeodataXforms that are computationally expensive, such as CoordinateXform, AdjustXform, and etc.

ApproximateXform approximates its base GeodataXform by applying the true transformation only on a coarse mesh, and performing bilinear interpolation for between points. ApproximateXform guarantees the approximation error does not exceed the specified tolerance.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ApproximationXform()
Constructs a ApproximationXform using ArcGIS Engine.

ApproximationXform(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ApproximationXform theApproximationXform = (ApproximationXform) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
IGeometry	computeFootprint(int direction, IGeometry pExtent, int maximumVertices) Computes the footprint in a given direction for a given input extent/footprint.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
double	getConstantZ() The constant Z value in meters.
IRaster	getDEM() The Digital Elevation Model (DEM).
IGeometryCollection	getDomains() The domains in output space.
IEnvelope	getFullExtent() The full output extent within which this xform is applied.
IGeodataXform	getGeodataXform() The geodataxform to be approximated.
int	getGridSize() The approximation grid size in pixels in output space.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The output spatial reference after applying this transform.
double	getTolerance() The approximation error tolerance in distance in input space.
double	getZ(double x, double y) Gets Z value for a given location (x,y) in map space.
double	getZFactor() The conversion factor from DEM Z unit to meters.
double	getZOffset() The Z offset in meters applied to DEM.
int	hashCode() the hashcode for this object
boolean	isApproximation() Indicates if approximation is on or off.
boolean	isCorrectGeoid() Indicates if Geoid correction is needed.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isIdentity() Indicates if this geodata transform is an identity transform.
boolean	isRecalculateTolerance() Indicates if the tolerance can be recalculated based on input cellsize.
boolean	isRequireDEM() Indicates if DEM is required for applying this transform.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	prepare(int iDomain, double dx, double dy, IEnvelope pExtent) Prepares the xform for a given extent and cellsize within a domain.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setApproximation(boolean pApproximation) Indicates if approximation is on or off.
void	setConstantZ(double z) The constant Z value in meters.
void	setCorrectGeoid(boolean pCorrection) Indicates if Geoid correction is needed.
void	setDEMByRef(IRaster ppDEM) The Digital Elevation Model (DEM).
void	setFullExtent(IEnvelope ppFullExtent) The full output extent within which this xform is applied.
void	setGeodataXformByRef(IGeodataXform ppXform) The geodataxform to be approximated.
void	setGridSize(int pSize) The approximation grid size in pixels in output space.
void	setRecalculateTolerance(boolean pRecalculateTolerance) Indicates if the tolerance can be recalculated based on input cellsize.
void	setRequireDEM(boolean pRequireDEM) Indicates if DEM is required for applying this transform.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialRefence) The output spatial reference after applying this transform.
void	setTolerance(double pTolerance) The approximation error tolerance in distance in input space.
void	setZFactor(double zFactor) The conversion factor from DEM Z unit to meters.
void	setZOffset(double zOffset) The Z offset in meters applied to DEM.
IGeodataXform	simplify() Simplifies into a simple geodataxform.
void	transform(int direction, int npoints, _WKSPoint[] points) Transforms a set of points in a given direction.
void	transform3D(int direction, int npoints, _WKSPointZ[] points) Transforms a set of 3D points in a given direction.
void	transform3DPoints(int direction, IPointCollection[] pPoints) Transforms a collection of 3D points in a given direction
void	transformCellsize(int direction, double[] dx, double[] dy, IEnvelope pAreaOfInterest) Transforms a cellsize in a given direction.
void	transformExtent(int direction, IEnvelope[] pExtent) Transforms an extent in a given direction.
void	transformMeasuresFF(int direction, int cMeasures, double[] inMeasures, double[] outMeasures) Transforms floating point measures to floating point measures (or do the inverse).
void	transformMeasuresFI(int direction, int cMeasures, double[] inMeasures, int[] outMeasures) Transforms floating point measures to integer measures (or do the inverse).
void	transformMeasuresIF(int direction, int cMeasures, int[] inMeasures, double[] outMeasures) Transforms integer measures to floating point measures (or do the inverse).
void	transformMeasuresII(int direction, int cMeasures, int[] inMeasures, int[] outMeasures) Transforms integer measures to integer measures (or do the inverse).
void	transformPoints(int direction, IPointCollection[] pPoints) Transforms a point collection in a given direction
void	transformPointsFF(int direction, int cPoints, double[] inPoints, double[] outPoints) Transforms floating point points to floating point points (or do the inverse).
void	transformPointsFI(int direction, int cPoints, double[] inPoints, int[] outPoints) Transforms floating point points to integer points (or do the inverse).
void	transformPointsIF(int direction, int cPoints, int[] inPoints, double[] outPoints) Transforms integer points to floating point points (or do the inverse).
void	transformPointsII(int direction, int cPoints, int[] inPoints, int[] outPoints) Transforms integer points to integer points (or do the inverse).
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ApproximationXform

public ApproximationXform()
                   throws IOException,
                          UnknownHostException

Constructs a ApproximationXform using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ApproximationXform

public ApproximationXform(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ApproximationXform theApproximationXform = (ApproximationXform) obj;

Construct a ApproximationXform using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ApproximationXform.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The output spatial reference after applying this transform.

Product Availability

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

Specified by:

getSpatialReference in interface IGeodataXform

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialRefence)
                              throws IOException,
                                     AutomationException

The output spatial reference after applying this transform.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface IGeodataXform

Parameters:

ppSpatialRefence - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomains

public IGeometryCollection getDomains()
                               throws IOException,
                                      AutomationException

The domains in output space.

Description

The returned domains should a single polygon geometry or a collection of polygons.

Product Availability

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

Specified by:

getDomains in interface IGeodataXform

Returns:

A reference to a com.esri.arcgis.geometry.IGeometryCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentity

public boolean isIdentity()
                   throws IOException,
                          AutomationException

Indicates if this geodata transform is an identity transform.

Product Availability

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

Specified by:

isIdentity in interface IGeodataXform

Returns:

The pIsIdentity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      int npoints,
                      _WKSPoint[] points)
               throws IOException,
                      AutomationException

Transforms a set of points in a given direction.

Product Availability

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

Specified by:

transform in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

npoints - The npoints (in)

points - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformCellsize

public void transformCellsize(int direction,
                              double[] dx,
                              double[] dy,
                              IEnvelope pAreaOfInterest)
                       throws IOException,
                              AutomationException

Transforms a cellsize in a given direction.

Product Availability

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

Specified by:

transformCellsize in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

dx - The dx (in/out: use single element array)

dy - The dy (in/out: use single element array)

pAreaOfInterest - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformExtent

public void transformExtent(int direction,
                            IEnvelope[] pExtent)
                     throws IOException,
                            AutomationException

Transforms an extent in a given direction.

Product Availability

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

Specified by:

transformExtent in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPoints

public void transformPoints(int direction,
                            IPointCollection[] pPoints)
                     throws IOException,
                            AutomationException

Transforms a point collection in a given direction

Product Availability

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

Specified by:

transformPoints in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform3D

public void transform3D(int direction,
                        int npoints,
                        _WKSPointZ[] points)
                 throws IOException,
                        AutomationException

Transforms a set of 3D points in a given direction.

Product Availability

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

Specified by:

transform3D in interface IGeodataXform2

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

npoints - The npoints (in)

points - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform3DPoints

public void transform3DPoints(int direction,
                              IPointCollection[] pPoints)
                       throws IOException,
                              AutomationException

Transforms a collection of 3D points in a given direction

Product Availability

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

Specified by:

transform3DPoints in interface IGeodataXform2

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeFootprint

public IGeometry computeFootprint(int direction,
                                  IGeometry pExtent,
                                  int maximumVertices)
                           throws IOException,
                                  AutomationException

Computes the footprint in a given direction for a given input extent/footprint.

Product Availability

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

Specified by:

computeFootprint in interface IGeodataXform2

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pExtent - A reference to a com.esri.arcgis.geometry.IGeometry (in)

maximumVertices - The maximumVertices (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZ

public double getZ(double x,
                   double y)
            throws IOException,
                   AutomationException

Gets Z value for a given location (x,y) in map space.

Product Availability

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

Specified by:

getZ in interface IGeodataXform2

Parameters:

x - The x (in)

y - The y (in)

Returns:

The z

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simplify

public IGeodataXform simplify()
                       throws IOException,
                              AutomationException

Simplifies into a simple geodataxform.

Product Availability

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

Specified by:

simplify in interface IGeodataXform2

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeodataXform

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeodataXformByRef

public void setGeodataXformByRef(IGeodataXform ppXform)
                          throws IOException,
                                 AutomationException

The geodataxform to be approximated.

Product Availability

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

Specified by:

setGeodataXformByRef in interface IApproximationXform

Parameters:

ppXform - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException

The geodataxform to be approximated.

Product Availability

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

Specified by:

getGeodataXform in interface IApproximationXform

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeodataXform

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

public IEnvelope getFullExtent()
                        throws IOException,
                               AutomationException

The full output extent within which this xform is applied.

Product Availability

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

Specified by:

getFullExtent in interface IRasterXform

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullExtent

public void setFullExtent(IEnvelope ppFullExtent)
                   throws IOException,
                          AutomationException

The full output extent within which this xform is applied.

Product Availability

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

Specified by:

setFullExtent in interface IRasterXform

Parameters:

ppFullExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepare

public void prepare(int iDomain,
                    double dx,
                    double dy,
                    IEnvelope pExtent)
             throws IOException,
                    AutomationException

Prepares the xform for a given extent and cellsize within a domain.

Product Availability

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

Specified by:

prepare in interface IRasterXform

Parameters:

iDomain - The iDomain (in)

dx - The dx (in)

dy - The dy (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstantZ

public double getConstantZ()
                    throws IOException,
                           AutomationException

The constant Z value in meters.

Remarks

This property can be used to set a constant elevation across the image when DEM method is not used.

Product Availability

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

Specified by:

getConstantZ in interface ISensorXform

Returns:

The z

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstantZ

public void setConstantZ(double z)
                  throws IOException,
                         AutomationException

The constant Z value in meters.

Product Availability

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

Specified by:

setConstantZ in interface ISensorXform

Parameters:

z - The z (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFactor

public double getZFactor()
                  throws IOException,
                         AutomationException

The conversion factor from DEM Z unit to meters.

Product Availability

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

Specified by:

getZFactor in interface ISensorXform

Returns:

The zFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFactor

public void setZFactor(double zFactor)
                throws IOException,
                       AutomationException

The conversion factor from DEM Z unit to meters.

Remarks

A factor that converts the unit of the DEM to meter

Product Availability

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

Specified by:

setZFactor in interface ISensorXform

Parameters:

zFactor - The zFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZOffset

public double getZOffset()
                  throws IOException,
                         AutomationException

The Z offset in meters applied to DEM.

Remarks

If the DEM data used is not based on sea level, this property can be used to do the adjustment.

Product Availability

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

Specified by:

getZOffset in interface ISensorXform

Returns:

The zOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZOffset

public void setZOffset(double zOffset)
                throws IOException,
                       AutomationException

The Z offset in meters applied to DEM.

Product Availability

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

Specified by:

setZOffset in interface ISensorXform

Parameters:

zOffset - The zOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDEM

public IRaster getDEM()
               throws IOException,
                      AutomationException

The Digital Elevation Model (DEM).

Product Availability

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

Specified by:

getDEM in interface ISensorXform

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDEMByRef

public void setDEMByRef(IRaster ppDEM)
                 throws IOException,
                        AutomationException

The Digital Elevation Model (DEM).

Remarks

Set the DEM to be used in orthorectification.

Product Availability

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

Specified by:

setDEMByRef in interface ISensorXform

Parameters:

ppDEM - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequireDEM

public boolean isRequireDEM()
                     throws IOException,
                            AutomationException

Indicates if DEM is required for applying this transform.

Product Availability

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

Specified by:

isRequireDEM in interface ISensorXform

Returns:

The pRequireDEM

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequireDEM

public void setRequireDEM(boolean pRequireDEM)
                   throws IOException,
                          AutomationException

Indicates if DEM is required for applying this transform.

Product Availability

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

Specified by:

setRequireDEM in interface ISensorXform

Parameters:

pRequireDEM - The pRequireDEM (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCorrectGeoid

public boolean isCorrectGeoid()
                       throws IOException,
                              AutomationException

Indicates if Geoid correction is needed.

Product Availability

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

Specified by:

isCorrectGeoid in interface ISensorXform

Returns:

The pCorrection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCorrectGeoid

public void setCorrectGeoid(boolean pCorrection)
                     throws IOException,
                            AutomationException

Indicates if Geoid correction is needed.

Remarks

If the property is set to true, the DEM used in orthorectification will be corrected to use the true elevation.

Product Availability

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

Specified by:

setCorrectGeoid in interface ISensorXform

Parameters:

pCorrection - The pCorrection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTolerance

public void setTolerance(double pTolerance)
                  throws IOException,
                         AutomationException

The approximation error tolerance in distance in input space.

Product Availability

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

Specified by:

setTolerance in interface IGeodataXformApproximation

Parameters:

pTolerance - The pTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTolerance

public double getTolerance()
                    throws IOException,
                           AutomationException

The approximation error tolerance in distance in input space.

Product Availability

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

Specified by:

getTolerance in interface IGeodataXformApproximation

Returns:

The pTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGridSize

public void setGridSize(int pSize)
                 throws IOException,
                        AutomationException

The approximation grid size in pixels in output space.

Product Availability

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

Specified by:

setGridSize in interface IGeodataXformApproximation

Parameters:

pSize - The pSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGridSize

public int getGridSize()
                throws IOException,
                       AutomationException

The approximation grid size in pixels in output space.

Product Availability

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

Specified by:

getGridSize in interface IGeodataXformApproximation

Returns:

The pSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecalculateTolerance

public void setRecalculateTolerance(boolean pRecalculateTolerance)
                             throws IOException,
                                    AutomationException

Indicates if the tolerance can be recalculated based on input cellsize.

Product Availability

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

Specified by:

setRecalculateTolerance in interface IGeodataXformApproximation

Parameters:

pRecalculateTolerance - The pRecalculateTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecalculateTolerance

public boolean isRecalculateTolerance()
                               throws IOException,
                                      AutomationException

Indicates if the tolerance can be recalculated based on input cellsize.

Product Availability

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

Specified by:

isRecalculateTolerance in interface IGeodataXformApproximation

Returns:

The pRecalculateTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApproximation

public boolean isApproximation()
                        throws IOException,
                               AutomationException

Indicates if approximation is on or off.

Product Availability

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

Specified by:

isApproximation in interface IGeodataXformApproximation

Returns:

The pApproximation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApproximation

public void setApproximation(boolean pApproximation)
                      throws IOException,
                             AutomationException

Indicates if approximation is on or off.

Product Availability

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

Specified by:

setApproximation in interface IGeodataXformApproximation

Parameters:

pApproximation - The pApproximation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresFF

public void transformMeasuresFF(int direction,
                                int cMeasures,
                                double[] inMeasures,
                                double[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms floating point measures to floating point measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresFF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresFI

public void transformMeasuresFI(int direction,
                                int cMeasures,
                                double[] inMeasures,
                                int[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms floating point measures to integer measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresFI in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresIF

public void transformMeasuresIF(int direction,
                                int cMeasures,
                                int[] inMeasures,
                                double[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms integer measures to floating point measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresIF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresII

public void transformMeasuresII(int direction,
                                int cMeasures,
                                int[] inMeasures,
                                int[] outMeasures)
                         throws IOException,
                                AutomationException

Transforms integer measures to integer measures (or do the inverse).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformMeasuresII in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsFF

public void transformPointsFF(int direction,
                              int cPoints,
                              double[] inPoints,
                              double[] outPoints)
                       throws IOException,
                              AutomationException

Transforms floating point points to floating point points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsFF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsFI

public void transformPointsFI(int direction,
                              int cPoints,
                              double[] inPoints,
                              int[] outPoints)
                       throws IOException,
                              AutomationException

Transforms floating point points to integer points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsFI in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsIF

public void transformPointsIF(int direction,
                              int cPoints,
                              int[] inPoints,
                              double[] outPoints)
                       throws IOException,
                              AutomationException

Transforms integer points to floating point points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsIF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsII

public void transformPointsII(int direction,
                              int cPoints,
                              int[] inPoints,
                              int[] outPoints)
                       throws IOException,
                              AutomationException

Transforms integer points to integer points (or do the inverse).

Remarks

The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

transformPointsII in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException