com.esri.arcgis.geometry
Interface ISpatialReference2GEN

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeographicCoordinateSystem, ProjectedCoordinateSystem, UnknownCoordinateSystem

public interface ISpatialReference2GEN
extends Serializable

Provides access to additional members that control a SpatialReference. ISpatialReference2GEN is generic version of ISpatialReference.

Superseded By

ISpatialReference3

Product Availability

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

Method Summary

void	applyPrecision(_WKSPoint[] points, double[] ms, double[] zs) Applies the measure and z value precisions.
void	applyXYPrecision(_WKSPoint[] points) Applies the XY precision.
void	changed() Notify this object that some of its parts have changed (parameter values, z unit, etc.).
String	getAbbreviation() The abbreviated name of this spatial reference component.
String	getAlias() The alias of this spatial reference component.
void	getDomain(double[] xMin, double[] xMax, double[] yMin, double[] yMax) Get the domain extent.
int	getFactoryCode() The factory code of the spatial reference.
void	getFalseOriginAndUnits(double[] falseX, double[] falseY, double[] xyUnits) Get the false origin and units.
void	getMDomain(double[] outMMin, double[] outMMax) Get the measure domain extent.
void	getMFalseOriginAndUnits(double[] falseM, double[] mUnits) Get the measure false origin and units.
String	getName() The name of this spatial reference component.
String	getRemarks() The comment string of this spatial reference component.
ILinearUnit	getZCoordinateUnit() The unit for the Z coordinate.
void	getZDomain(double[] outZMin, double[] outZMax) Get the Z domain extent.
void	getZFalseOriginAndUnits(double[] falseZ, double[] zUnits) Get the Z false origin and units.
boolean	hasMPrecision() Returns true when m-value precision information has been defined.
boolean	hasXYPrecision() Returns true when (x,y) precision information has been defined.
boolean	hasZPrecision() Returns true when z-value precision information has been defined.
boolean	isMPrecisionEqual(ISpatialReference otherSR) Returns true if the measure precisions of the two spatial references are the same.
void	isPrecisionEqual(ISpatialReference otherSR, boolean[] isPrecisionEqual) Returns TRUE when the precision information for the two spatial references is the same.
boolean	isXYPrecisionEqual(ISpatialReference otherSR) Returns true if the XY precisions of the two spatial references are the same.
boolean	isZPrecisionEqual(ISpatialReference otherSR) Returns true if the Z precisions of the two spatial references are the same.
void	setDomain(double xMin, double xMax, double yMin, double yMax) Set the xy domain extent.
void	setFalseOriginAndUnits(double falseX, double falseY, double xyUnits) Set the false origin and units.
void	setMDomain(double inMMin, double inMMax) Set the measure domain extent.
void	setMFalseOriginAndUnits(double falseM, double mUnits) Set the measure false origin and units.
void	setZCoordinateUnit(ILinearUnit zunit) The unit for the Z coordinate.
void	setZDomain(double inZMin, double inZMax) Set the z domain extent.
void	setZFalseOriginAndUnits(double falseZ, double zUnits) Set the Z false origin and units.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of this spatial reference component.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

String getAlias()
                throws IOException,
                       AutomationException

The alias of this spatial reference component.

Product Availability

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

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAbbreviation

String getAbbreviation()
                       throws IOException,
                              AutomationException

The abbreviated name of this spatial reference component.

Product Availability

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

Returns:

The abbreviation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemarks

String getRemarks()
                  throws IOException,
                         AutomationException

The comment string of this spatial reference component.

Product Availability

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

Returns:

The remarks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFactoryCode

int getFactoryCode()
                   throws IOException,
                          AutomationException

The factory code of the spatial reference.

Remarks

The factory code is an integer identifier that is unique by projection engine object type, such as a projected coordinate system. You can use a factory code in the ISpatialReferenceFactory::CreateProjectedCoordinateSystem method for example. If you create a custom projected coordinate system, the factory code is zero.

Product Availability

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

Returns:

The code

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasXYPrecision

boolean hasXYPrecision()
                       throws IOException,
                              AutomationException

Returns true when (x,y) precision information has been defined.

Product Availability

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

Returns:

The hasXYPrecision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasZPrecision

boolean hasZPrecision()
                      throws IOException,
                             AutomationException

Returns true when z-value precision information has been defined.

Product Availability

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

Returns:

The hasZPrecision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasMPrecision

boolean hasMPrecision()
                      throws IOException,
                             AutomationException

Returns true when m-value precision information has been defined.

Product Availability

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

Returns:

The hasMPrecision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrecisionEqual

void isPrecisionEqual(ISpatialReference otherSR,
                      boolean[] isPrecisionEqual)
                      throws IOException,
                             AutomationException

Returns TRUE when the precision information for the two spatial references is the same.

Product Availability

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

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFalseOriginAndUnits

void setFalseOriginAndUnits(double falseX,
                            double falseY,
                            double xyUnits)
                            throws IOException,
                                   AutomationException

Set the false origin and units.

Product Availability

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

Parameters:

falseX - The falseX (in)

falseY - The falseY (in)

xyUnits - The xyUnits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFalseOriginAndUnits

void setZFalseOriginAndUnits(double falseZ,
                             double zUnits)
                             throws IOException,
                                    AutomationException

Set the Z false origin and units.

Product Availability

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

Parameters:

falseZ - The falseZ (in)

zUnits - The zUnits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMFalseOriginAndUnits

void setMFalseOriginAndUnits(double falseM,
                             double mUnits)
                             throws IOException,
                                    AutomationException

Set the measure false origin and units.

Product Availability

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

Parameters:

falseM - The falseM (in)

mUnits - The mUnits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFalseOriginAndUnits

void getFalseOriginAndUnits(double[] falseX,
                            double[] falseY,
                            double[] xyUnits)
                            throws IOException,
                                   AutomationException

Get the false origin and units.

Product Availability

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

Parameters:

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFalseOriginAndUnits

void getZFalseOriginAndUnits(double[] falseZ,
                             double[] zUnits)
                             throws IOException,
                                    AutomationException

Get the Z false origin and units.

Product Availability

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

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMFalseOriginAndUnits

void getMFalseOriginAndUnits(double[] falseM,
                             double[] mUnits)
                             throws IOException,
                                    AutomationException

Get the measure false origin and units.

Product Availability

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

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomain

void getDomain(double[] xMin,
               double[] xMax,
               double[] yMin,
               double[] yMax)
               throws IOException,
                      AutomationException

Get the domain extent.

Product Availability

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

Parameters:

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

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDomain

void setDomain(double xMin,
               double xMax,
               double yMin,
               double yMax)
               throws IOException,
                      AutomationException

Set the xy domain extent.

Product Availability

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

Parameters:

xMin - The xMin (in)

xMax - The xMax (in)

yMin - The yMin (in)

yMax - The yMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZDomain

void getZDomain(double[] outZMin,
                double[] outZMax)
                throws IOException,
                       AutomationException

Get the Z domain extent.

Product Availability

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

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZDomain

void setZDomain(double inZMin,
                double inZMax)
                throws IOException,
                       AutomationException

Set the z domain extent.

Product Availability

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

Parameters:

inZMin - The inZMin (in)

inZMax - The inZMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMDomain

void getMDomain(double[] outMMin,
                double[] outMMax)
                throws IOException,
                       AutomationException

Get the measure domain extent.

Product Availability

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

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMDomain

void setMDomain(double inMMin,
                double inMMax)
                throws IOException,
                       AutomationException

Set the measure domain extent.

Product Availability

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

Parameters:

inMMin - The inMMin (in)

inMMax - The inMMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZCoordinateUnit

ILinearUnit getZCoordinateUnit()
                               throws IOException,
                                      AutomationException

The unit for the Z coordinate.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZCoordinateUnit

void setZCoordinateUnit(ILinearUnit zunit)
                        throws IOException,
                               AutomationException

The unit for the Z coordinate.

Product Availability

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

Parameters:

zunit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changed

void changed()
             throws IOException,
                    AutomationException

Notify this object that some of its parts have changed (parameter values, z unit, etc.).

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isXYPrecisionEqual

boolean isXYPrecisionEqual(ISpatialReference otherSR)
                           throws IOException,
                                  AutomationException

Returns true if the XY precisions of the two spatial references are the same.

Product Availability

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

Parameters:

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

Returns:

The isXYPrecisionEqual

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMPrecisionEqual

boolean isMPrecisionEqual(ISpatialReference otherSR)
                          throws IOException,
                                 AutomationException

Returns true if the measure precisions of the two spatial references are the same.

Product Availability

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

Parameters:

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

Returns:

The isMPrecisionEqual

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZPrecisionEqual

boolean isZPrecisionEqual(ISpatialReference otherSR)
                          throws IOException,
                                 AutomationException

Returns true if the Z precisions of the two spatial references are the same.

Product Availability

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

Parameters:

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

Returns:

The isZPrecisionEqual

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyXYPrecision

void applyXYPrecision(_WKSPoint[] points)
                      throws IOException,
                             AutomationException

Applies the XY precision.

Product Availability

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

Parameters:

points - A Structure: com.esri.arcgis.system._WKSPoint (An array of com.esri.arcgis.system._WKSPoint COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyPrecision

void applyPrecision(_WKSPoint[] points,
                    double[] ms,
                    double[] zs)
                    throws IOException,
                           AutomationException

Applies the measure and z value precisions.

Product Availability

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

Parameters:

points - A Structure: com.esri.arcgis.system._WKSPoint (An array of com.esri.arcgis.system._WKSPoint COM typedef) (in)

ms - The ms (in)

zs - The zs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.