com.esri.arcgis.geometry

Class VerticalDatum

java.lang.Object

com.esri.arcgis.geometry.VerticalDatum

All Implemented Interfaces:

IESRISpatialReference, IESRISpatialReferenceGEN, IESRISpatialReferenceGEN2, IHVDatum, ISpatialReferenceAuthority, ISpatialReferenceInfo, IVerticalDatum, IVerticalDatumEdit, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class VerticalDatum
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IESRISpatialReferenceGEN, IESRISpatialReferenceGEN2, IHVDatum, IVerticalDatum, IVerticalDatumEdit, ISpatialReferenceInfo, IClone, IPersist, IPersistStream, IESRISpatialReference, ISupportErrorInfo, ISpatialReferenceAuthority, java.io.Externalizable

COM Class 'VerticalDatum'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriGeometry.tlb'

Description 'Creates a vertical datum.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geometry.IESRISpatialReferenceGEN

IID, IIDf90e304c_a0f7_4a7d_9f62_25fd2a5c96af, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IESRISpatialReferenceGEN2

IID, IID3f9863b9_5477_4757_ac6f_63204de301ee, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IHVDatum

IID, IID8ebb735d_1ad3_45e8_b3a0_11fba705203c, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IVerticalDatum

IID, IID81e15eb5_4a1d_4adf_bf96_e0ca31d17cfd, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ISpatialReferenceInfo

IID4da0fe00_1dd2_11b2_bf49_08002022f573

Fields inherited from interface com.esri.arcgis.geometry.IVerticalDatumEdit

IID, IID7e887f04_3f5a_4d26_ac12_41b33cf253bb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.geometry.IESRISpatialReference

IID, IIDbf8786d0_4fc5_487b_9e6a_53e5cb5619c1, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ISpatialReferenceAuthority

IID, IIDd2f20dac_5ca7_4b58_bddb_309fdd0e364a, xxDummy

Constructor Summary

Constructors

Constructor and Description
VerticalDatum() Constructs a VerticalDatum using ArcGIS Engine.
VerticalDatum(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. VerticalDatum theVerticalDatum = (VerticalDatum) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
void	define(java.lang.Object name, java.lang.Object alias, java.lang.Object abbreviation, java.lang.Object remarks) Defines the properties of a vertical datum.
void	define(java.lang.String authorityName, int authorityCode, java.lang.String authorityVersion) Defines the authority-related metadata properties for this spatial reference object.
void	defineEx(java.lang.String name, java.lang.String alias, java.lang.String abbreviation, java.lang.String remarks) Defines the properties of a vertical datum.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	exportToESRISpatialReference(java.lang.String[] str, int[] cBytesWrote) Exports this spatial reference component to a buffer.
void	exportToESRISpatialReference2(java.lang.String[] str, int[] cBytesWrote) Exports this spatial reference component to a buffer.
java.lang.String	getAbbreviation() The abbreviated name of this spatial reference component.
java.lang.String	getAlias() The alias of this spatial reference component.
java.lang.String	getAuthorityName() The name of the defining authority for this object.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCode() The code identifying this object relative to its authority.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getName() The name of this spatial reference component.
java.lang.String	getRemarks() The comment string of this spatial reference component.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getVersion() The version of this spatial reference object.
int	hashCode() the hashcode for this object
void	importFromESRISpatialReference(java.lang.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) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

VerticalDatum

public VerticalDatum()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a VerticalDatum using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

VerticalDatum

public VerticalDatum(java.lang.Object obj)
              throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getESRISpatialReferenceSize

public int getESRISpatialReferenceSize()
                                throws java.io.IOException,
                                       AutomationException

The number of bytes required to hold the persistant representation of this spatial reference component.

Specified by:

getESRISpatialReferenceSize in interface IESRISpatialReference

Specified by:

getESRISpatialReferenceSize in interface IESRISpatialReferenceGEN

Specified by:

getESRISpatialReferenceSize in interface IESRISpatialReferenceGEN2

Returns:

The cBytes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

importFromESRISpatialReference

public void importFromESRISpatialReference(java.lang.String str,
                                           int[] cBytesRead)
                                    throws java.io.IOException,
                                           AutomationException

Defines this spatial reference component from the specified ESRISpatialReference buffer.

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:

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

AutomationException - If the ArcObject component throws an exception.

exportToESRISpatialReference

public void exportToESRISpatialReference(java.lang.String[] str,
                                         int[] cBytesWrote)
                                  throws java.io.IOException,
                                         AutomationException

Exports this spatial reference component to a buffer.

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:

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

AutomationException - If the ArcObject component throws an exception.

exportToESRISpatialReference2

public void exportToESRISpatialReference2(java.lang.String[] str,
                                          int[] cBytesWrote)
                                   throws java.io.IOException,
                                          AutomationException

Exports this spatial reference component to a buffer.

Specified by:

exportToESRISpatialReference2 in interface IESRISpatialReferenceGEN2

Parameters:

str - The str (out: use single element array)

cBytesWrote - The cBytesWrote (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of this spatial reference component.

Specified by:

getName in interface ISpatialReferenceInfo

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.

Specified by:

getAlias in interface ISpatialReferenceInfo

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.

Specified by:

getAbbreviation in interface ISpatialReferenceInfo

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.

Specified by:

getRemarks in interface ISpatialReferenceInfo

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 (WKID) of the spatial reference.

Specified by:

getFactoryCode in interface ISpatialReferenceInfo

Returns:

The code

Throws:

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

AutomationException - If the ArcObject component throws an exception.

defineEx

public void defineEx(java.lang.String name,
                     java.lang.String alias,
                     java.lang.String abbreviation,
                     java.lang.String remarks)
              throws java.io.IOException,
                     AutomationException

Defines the properties of a vertical datum.

Specified by:

defineEx in interface IVerticalDatumEdit

Parameters:

name - The name (in)

alias - The alias (in)

abbreviation - The abbreviation (in)

remarks - The remarks (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

define

public void define(java.lang.Object name,
                   java.lang.Object alias,
                   java.lang.Object abbreviation,
                   java.lang.Object remarks)
            throws java.io.IOException,
                   AutomationException

Defines the properties of a vertical datum.

Specified by:

define in interface IVerticalDatumEdit

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)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAuthorityName

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

The name of the defining authority for this object.

Specified by:

getAuthorityName in interface ISpatialReferenceAuthority

Returns:

The pAuthName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersion

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

The version of this spatial reference object.

Specified by:

getVersion in interface ISpatialReferenceAuthority

Returns:

The pVersion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCode

public int getCode()
            throws java.io.IOException,
                   AutomationException

The code identifying this object relative to its authority. For the EPSG authority, this will initially be the WKID (factory code).

Specified by:

getCode in interface ISpatialReferenceAuthority

Returns:

The pAuthCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

define

public void define(java.lang.String authorityName,
                   int authorityCode,
                   java.lang.String authorityVersion)
            throws java.io.IOException,
                   AutomationException

Defines the authority-related metadata properties for this spatial reference object.

Specified by:

define in interface ISpatialReferenceAuthority

Parameters:

authorityName - The authorityName (in)

authorityCode - The authorityCode (in)

authorityVersion - The authorityVersion (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException