com.esri.arcgis.geometry
Class VerticalCoordinateSystem

java.lang.Object
  extended by com.esri.arcgis.geometry.VerticalCoordinateSystem
All Implemented Interfaces:
IESRISpatialReference, IESRISpatialReferenceGEN, IESRISpatialReferenceGEN2, ISpatialReferenceAuthority, ISpatialReferenceInfo, IVerticalCoordinateSystem, IVerticalCoordinateSystemEdit, IVerticalCoordinateSystemGEN, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class VerticalCoordinateSystem
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IVerticalCoordinateSystemGEN, IVerticalCoordinateSystem, IESRISpatialReferenceGEN, IESRISpatialReferenceGEN2, IVerticalCoordinateSystemEdit, ISpatialReferenceInfo, IESRISpatialReference, IClone, IPersist, IPersistStream, ISupportErrorInfo, ISpatialReferenceAuthority, Externalizable

Creates a vertical coordinate system.

Description

A vertical coordinate system has two types. It can either be gravity-related, which requires a VerticalDatum; or ellipsoid/spheroid-based which requires a horizontal Datum. A horizontal Datum is the same as one used for a geographic coordinate system. It has a linear unit of measure. A VCS has two parameters. The positiveDirection value defines whether the vertical coordinate system has positive values 'up', for heights, or 'down', for depths. Use -1 for positive depths. The verticalShift parameter is a way to identify this VCS as offset from some other known surface. For example, you might know that a dataset's depths are referenced to mean lower low water (a tidal level). You might also know that for this dataset, mean lower low water is 1.23 meters 'down' from local mean sea level. The VCS could be defined for mean sea level but with a verticalShift of -1.23 to shift the 'zero' level to mean lower low water.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
VerticalCoordinateSystem()
          Constructs a VerticalCoordinateSystem using ArcGIS Engine.
VerticalCoordinateSystem(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
VerticalCoordinateSystem theVerticalCoordinateSystem = (VerticalCoordinateSystem) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void define(Object name, Object alias, Object abbreviation, Object remarks, Object useage, Object hvDatum, Object projectedUnit, Object verticalShift, Object positiveDirection)
          Defines the properties of a vertical coordinate system.
 void define(String authorityName, int authorityCode, String authorityVersion)
          Defines the authority-related metadata properties for this spatial reference object.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void exportToESRISpatialReference(String[] str, int[] cBytesWrote)
          Exports this spatial reference component to a buffer.
 void exportToESRISpatialReference2(String[] str, int[] cBytesWrote)
          Exports this spatial reference component to a buffer.
 String getAbbreviation()
          The abbreviated name of this spatial reference component.
 String getAlias()
          The alias of this spatial reference component.
 String getAuthorityName()
          The name of the defining authority for this object.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCode()
          The code identifying this object relative to its authority.
 ILinearUnit getCoordinateUnit()
          The linear unit of measure for the vertical coordinate system.
 IHVDatum getDatum()
          The vertical or horizontal datum of the vertical coordinate system.
 int getESRISpatialReferenceSize()
          The number of bytes required to hold the persistant representation of this spatial reference component.
 int getFactoryCode()
          The factory code (WKID) of the spatial reference.
 String getName()
          The name of this spatial reference component.
 void getParameters(IParameter[] parameters)
          Gets the vertical coordinate system parameters.
 void getParameters(IParameter[][] parameters)
          Retrieves the PositiveDirection and VerticalShift parameters into an array.
 int getPositiveDirection()
          A parameter that determines whether the coordinate system is positive 'up' or 'down'.
 String getRemarks()
          The comment string of this spatial reference component.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 String getUsage()
          The usage notes of a vertical coordinate system.
 String getVersion()
          The version of this spatial reference object.
 double getVerticalShift()
          An offset parameter that changes the origin of the vertical coordinate system.
 int hashCode()
          the hashcode for this object
 void importFromESRISpatialReference(String str, int[] cBytesRead)
          Defines this spatial reference component from the specified ESRISpatialReference buffer.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setCoordinateUnit(ILinearUnit unit)
          The linear unit of measure for the vertical coordinate system.
 void setPositiveDirection(int pd)
          The positive direction of the z coordinates.
 void setVerticalShift(double vshift)
          An offset parameter that changes the origin of the vertical coordinate system.
 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

VerticalCoordinateSystem

public VerticalCoordinateSystem()
                         throws IOException,
                                UnknownHostException
Constructs a VerticalCoordinateSystem using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

VerticalCoordinateSystem

public VerticalCoordinateSystem(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
VerticalCoordinateSystem theVerticalCoordinateSystem = (VerticalCoordinateSystem) obj;

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

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

getUsage

public String getUsage()
                throws IOException,
                       AutomationException
The usage notes of a vertical coordinate system.

Product Availability

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

Specified by:
getUsage in interface IVerticalCoordinateSystem
Specified by:
getUsage in interface IVerticalCoordinateSystemGEN
Returns:
The usage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatum

public IHVDatum getDatum()
                  throws IOException,
                         AutomationException
The vertical or horizontal datum of the vertical coordinate system.

Description

Retrieves the vertical or horizontal datum of the vertical coordinate system as IHVDatum.

Product Availability

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

Specified by:
getDatum in interface IVerticalCoordinateSystem
Specified by:
getDatum in interface IVerticalCoordinateSystemGEN
Returns:
A reference to a com.esri.arcgis.geometry.IHVDatum
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCoordinateUnit

public ILinearUnit getCoordinateUnit()
                              throws IOException,
                                     AutomationException
The linear unit of measure for the vertical coordinate system.

Description

The unit of measure of the vertical coordinate system. The unit is always be a linear unit such as meters.

Product Availability

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

Specified by:
getCoordinateUnit in interface IVerticalCoordinateSystem
Specified by:
getCoordinateUnit in interface IVerticalCoordinateSystemGEN
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.

setCoordinateUnit

public void setCoordinateUnit(ILinearUnit unit)
                       throws IOException,
                              AutomationException
The linear unit of measure for the vertical coordinate system.

Product Availability

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

Specified by:
setCoordinateUnit in interface IVerticalCoordinateSystem
Specified by:
setCoordinateUnit in interface IVerticalCoordinateSystemGEN
Parameters:
unit - 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.

getVerticalShift

public double getVerticalShift()
                        throws IOException,
                               AutomationException
An offset parameter that changes the origin of the vertical coordinate system.

Description

The verticalShift parameter is a way to identify this VCS as offset from some other known surface. For example, you might know that a dataset's depths are referenced to mean lower low water (a tidal level). You might also know that for this dataset, mean lower low water is 1.23 meters 'down' from local mean sea level. The VCS could be defined for mean sea level but with a verticalShift of -1.23 to shift the 'zero' level to mean lower low water.

Product Availability

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

Specified by:
getVerticalShift in interface IVerticalCoordinateSystem
Specified by:
getVerticalShift in interface IVerticalCoordinateSystemGEN
Returns:
The vshift
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalShift

public void setVerticalShift(double vshift)
                      throws IOException,
                             AutomationException
An offset parameter that changes the origin of the vertical coordinate system.

Product Availability

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

Specified by:
setVerticalShift in interface IVerticalCoordinateSystem
Specified by:
setVerticalShift in interface IVerticalCoordinateSystemGEN
Parameters:
vshift - The vshift (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPositiveDirection

public int getPositiveDirection()
                         throws IOException,
                                AutomationException
A parameter that determines whether the coordinate system is positive 'up' or 'down'. Use -1 for depths (positive down).

Description

The positiveDirection value defines whether the vertical coordinate system has positive values 'up', for heights, or 'down', for depths. Use -1 for positive depths.

Product Availability

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

Specified by:
getPositiveDirection in interface IVerticalCoordinateSystem
Specified by:
getPositiveDirection in interface IVerticalCoordinateSystemGEN
Returns:
The pd
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameters

public void getParameters(IParameter[][] parameters)
                   throws IOException,
                          AutomationException
Retrieves the PositiveDirection and VerticalShift parameters into an array.

Description

Returns the PositiveDirection and VerticalShift parameters in an array of IParameters.

Product Availability

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

Specified by:
getParameters in interface IVerticalCoordinateSystemGEN
Parameters:
parameters - A reference to a com.esri.arcgis.geometry.IParameter array (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPositiveDirection

public void setPositiveDirection(int pd)
                          throws IOException,
                                 AutomationException
The positive direction of the z coordinates. Up is 1. Down (in the direction of gravity) is -1.

Product Availability

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

Specified by:
setPositiveDirection in interface IVerticalCoordinateSystem
Parameters:
pd - The pd (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameters

public void getParameters(IParameter[] parameters)
                   throws IOException,
                          AutomationException
Gets the vertical coordinate system parameters.

Description

Returns the PositiveDirection and VerticalShift parameters in an array of IParameters.

Product Availability

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

Specified by:
getParameters in interface IVerticalCoordinateSystem
Parameters:
parameters - A reference to a com.esri.arcgis.geometry.IParameter (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of this spatial reference component.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface ISpatialReferenceInfo
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws IOException,
                       AutomationException
The alias of this spatial reference component.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAlias in interface ISpatialReferenceInfo
Returns:
The alias
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAbbreviation

public String getAbbreviation()
                       throws IOException,
                              AutomationException
The abbreviated name of this spatial reference component.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAbbreviation in interface ISpatialReferenceInfo
Returns:
The abbreviation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRemarks

public String getRemarks()
                  throws IOException,
                         AutomationException
The comment string of this spatial reference component.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRemarks in interface ISpatialReferenceInfo
Returns:
The remarks
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFactoryCode

public int getFactoryCode()
                   throws IOException,
                          AutomationException
The factory code (WKID) 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFactoryCode in interface ISpatialReferenceInfo
Returns:
The code
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getESRISpatialReferenceSize

public int getESRISpatialReferenceSize()
                                throws IOException,
                                       AutomationException
The number of bytes required to hold the persistant representation of this spatial reference component.

Product Availability

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

Specified by:
getESRISpatialReferenceSize in interface IESRISpatialReference
Specified by:
getESRISpatialReferenceSize in interface IESRISpatialReferenceGEN
Specified by:
getESRISpatialReferenceSize in interface IESRISpatialReferenceGEN2
Returns:
The cBytes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

importFromESRISpatialReference

public void importFromESRISpatialReference(String str,
                                           int[] cBytesRead)
                                    throws IOException,
                                           AutomationException
Defines this spatial reference component from the specified ESRISpatialReference buffer.

Product Availability

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

Specified by:
importFromESRISpatialReference in interface IESRISpatialReference
Specified by:
importFromESRISpatialReference in interface IESRISpatialReferenceGEN
Specified by:
importFromESRISpatialReference in interface IESRISpatialReferenceGEN2
Parameters:
str - The str (in)
cBytesRead - The cBytesRead (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportToESRISpatialReference

public void exportToESRISpatialReference(String[] str,
                                         int[] cBytesWrote)
                                  throws IOException,
                                         AutomationException
Exports this spatial reference component to a buffer.

Product Availability

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

Specified by:
exportToESRISpatialReference in interface IESRISpatialReference
Specified by:
exportToESRISpatialReference in interface IESRISpatialReferenceGEN
Parameters:
str - The str (out: use single element array)
cBytesWrote - The cBytesWrote (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportToESRISpatialReference2

public void exportToESRISpatialReference2(String[] str,
                                          int[] cBytesWrote)
                                   throws IOException,
                                          AutomationException
Exports this spatial reference component to a buffer.

Product Availability

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

Specified by:
exportToESRISpatialReference2 in interface IESRISpatialReferenceGEN2
Parameters:
str - The str (out: use single element array)
cBytesWrote - The cBytesWrote (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

define

public void define(Object name,
                   Object alias,
                   Object abbreviation,
                   Object remarks,
                   Object useage,
                   Object hvDatum,
                   Object projectedUnit,
                   Object verticalShift,
                   Object positiveDirection)
            throws IOException,
                   AutomationException
Defines the properties of a vertical coordinate system.

Description

The Define method allows you to create a custom vertical coordinate system (VCS). You can use ISpatialReferenceFactory3 to create the predefined objects you need to define a VCS or use the various Edit interfaces to create custom objects.

A vertical coordinate system has two types. It can either be gravity-related, which requires a VerticalDatum; or ellipsoid/spheroid-based which requires a horizontal Datum. A horizontal Datum is the same as one used for a geographic coordinate system. You will also need a (linear) projectedUnit object. A VCS has two parameters. The positiveDirection value defines whether the vertical coordinate system has positive values 'up', heights, or 'down', depths. Use -1 for positive depths. The verticalShift parameter is a way to identify this VCS as offset from some other known surface. For example, you might know that a dataset's depths are referenced to mean lower low water (a tidal level). You might also know that for this dataset, mean lower low water is 1.23 meters below local mean sea level. The VCS could be defined for mean sea level but with a verticalShift of -1.23.

Product Availability

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

Specified by:
define in interface IVerticalCoordinateSystemEdit
Parameters:
name - A Variant (in, optional, pass null if not required)
alias - A Variant (in, optional, pass null if not required)
abbreviation - A Variant (in, optional, pass null if not required)
remarks - A Variant (in, optional, pass null if not required)
useage - A Variant (in, optional, pass null if not required)
hvDatum - A Variant (in, optional, pass null if not required)
projectedUnit - A Variant (in, optional, pass null if not required)
verticalShift - A Variant (in, optional, pass null if not required)
positiveDirection - A Variant (in, optional, pass null if not required)
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
Returns TRUE when 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
Returns TRUE when 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.

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAuthorityName

public String getAuthorityName()
                        throws IOException,
                               AutomationException
The name of the defining authority for this object.

Product Availability

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

Specified by:
getAuthorityName in interface ISpatialReferenceAuthority
Returns:
The pAuthName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVersion

public String getVersion()
                  throws IOException,
                         AutomationException
The version of this spatial reference object.

Product Availability

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

Specified by:
getVersion in interface ISpatialReferenceAuthority
Returns:
The pVersion
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCode

public int getCode()
            throws IOException,
                   AutomationException
The code identifying this object relative to its authority. For the EPSG authority, this will initially be the WKID (factory code).

Product Availability

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

Specified by:
getCode in interface ISpatialReferenceAuthority
Returns:
The pAuthCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

define

public void define(String authorityName,
                   int authorityCode,
                   String authorityVersion)
            throws IOException,
                   AutomationException
Defines the authority-related metadata properties for this spatial reference object.

Product Availability

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

Specified by:
define in interface ISpatialReferenceAuthority
Parameters:
authorityName - The authorityName (in)
authorityCode - The authorityCode (in)
authorityVersion - The authorityVersion (in)
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