com.esri.arcgis.geometry
Interface ISpatialReference2GEN

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GeographicCoordinateSystem, ISpatialReference2GENProxy, ProjectedCoordinateSystem, UnknownCoordinateSystem

public interface ISpatialReference2GEN

extends java.io.Serializable

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

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.).
java.lang.String	getAbbreviation() The abbreviated name of this spatial reference component.
java.lang.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.
java.lang.String	getName() The name of this spatial reference component.
java.lang.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

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of this spatial reference component.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

public java.lang.String getAlias()
                          throws java.io.IOException,
                                 AutomationException

The alias of this spatial reference component.

Returns:

The alias

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAbbreviation

public java.lang.String getAbbreviation()
                                 throws java.io.IOException,
                                        AutomationException

The abbreviated name of this spatial reference component.

Returns:

The abbreviation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemarks

public java.lang.String getRemarks()
                            throws java.io.IOException,
                                   AutomationException

The comment string of this spatial reference component.

Returns:

The remarks

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFactoryCode

public int getFactoryCode()
                   throws java.io.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.

Returns:

The code

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasXYPrecision

public boolean hasXYPrecision()
                       throws java.io.IOException,
                              AutomationException

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

Returns:

The hasXYPrecision

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasZPrecision

public boolean hasZPrecision()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

The hasZPrecision

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasMPrecision

public boolean hasMPrecision()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

The hasMPrecision

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrecisionEqual

public void isPrecisionEqual(ISpatialReference otherSR,
                             boolean[] isPrecisionEqual)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFalseOriginAndUnits

public void setFalseOriginAndUnits(double falseX,
                                   double falseY,
                                   double xyUnits)
                            throws java.io.IOException,
                                   AutomationException

Set the false origin and units.

Parameters:

falseX - The falseX (in)

falseY - The falseY (in)

xyUnits - The xyUnits (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFalseOriginAndUnits

public void setZFalseOriginAndUnits(double falseZ,
                                    double zUnits)
                             throws java.io.IOException,
                                    AutomationException

Set the Z false origin and units.

Parameters:

falseZ - The falseZ (in)

zUnits - The zUnits (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMFalseOriginAndUnits

public void setMFalseOriginAndUnits(double falseM,
                                    double mUnits)
                             throws java.io.IOException,
                                    AutomationException

Set the measure false origin and units.

Parameters:

falseM - The falseM (in)

mUnits - The mUnits (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFalseOriginAndUnits

public void getFalseOriginAndUnits(double[] falseX,
                                   double[] falseY,
                                   double[] xyUnits)
                            throws java.io.IOException,
                                   AutomationException

Get the false origin and units.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFalseOriginAndUnits

public void getZFalseOriginAndUnits(double[] falseZ,
                                    double[] zUnits)
                             throws java.io.IOException,
                                    AutomationException

Get the Z false origin and units.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMFalseOriginAndUnits

public void getMFalseOriginAndUnits(double[] falseM,
                                    double[] mUnits)
                             throws java.io.IOException,
                                    AutomationException

Get the measure false origin and units.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomain

public void getDomain(double[] xMin,
                      double[] xMax,
                      double[] yMin,
                      double[] yMax)
               throws java.io.IOException,
                      AutomationException

Get the domain extent.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDomain

public void setDomain(double xMin,
                      double xMax,
                      double yMin,
                      double yMax)
               throws java.io.IOException,
                      AutomationException

Set the xy domain extent.

Parameters:

xMin - The xMin (in)

xMax - The xMax (in)

yMin - The yMin (in)

yMax - The yMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZDomain

public void getZDomain(double[] outZMin,
                       double[] outZMax)
                throws java.io.IOException,
                       AutomationException

Get the Z domain extent.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZDomain

public void setZDomain(double inZMin,
                       double inZMax)
                throws java.io.IOException,
                       AutomationException

Set the z domain extent.

Parameters:

inZMin - The inZMin (in)

inZMax - The inZMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMDomain

public void getMDomain(double[] outMMin,
                       double[] outMMax)
                throws java.io.IOException,
                       AutomationException

Get the measure domain extent.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMDomain

public void setMDomain(double inMMin,
                       double inMMax)
                throws java.io.IOException,
                       AutomationException

Set the measure domain extent.

Parameters:

inMMin - The inMMin (in)

inMMax - The inMMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZCoordinateUnit

public ILinearUnit getZCoordinateUnit()
                               throws java.io.IOException,
                                      AutomationException

The unit for the Z coordinate.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZCoordinateUnit

public void setZCoordinateUnit(ILinearUnit zunit)
                        throws java.io.IOException,
                               AutomationException

The unit for the Z coordinate.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changed

public void changed()
             throws java.io.IOException,
                    AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isXYPrecisionEqual

public boolean isXYPrecisionEqual(ISpatialReference otherSR)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

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

Returns:

The isXYPrecisionEqual

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMPrecisionEqual

public boolean isMPrecisionEqual(ISpatialReference otherSR)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

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

Returns:

The isMPrecisionEqual

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZPrecisionEqual

public boolean isZPrecisionEqual(ISpatialReference otherSR)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

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

Returns:

The isZPrecisionEqual

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyXYPrecision

public void applyXYPrecision(_WKSPoint[] points)
                      throws java.io.IOException,
                             AutomationException

Applies the XY precision.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyPrecision

public void applyPrecision(_WKSPoint[] points,
                           double[] ms,
                           double[] zs)
                    throws java.io.IOException,
                           AutomationException

Applies the measure and z value precisions.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.