com.esri.arcgis.geometry
Interface IVerticalCoordinateSystem

All Superinterfaces:

ISpatialReferenceInfo, java.io.Serializable

All Known Implementing Classes:

IVerticalCoordinateSystemProxy, VerticalCoordinateSystem

public interface IVerticalCoordinateSystem
extends ISpatialReferenceInfo, java.io.Serializable

COM Interface 'IVerticalCoordinateSystem'. Generated 3/19/2015 1:20:57 PM from 'C:\ArcGIS\COM\esriGeometry.olb'

Description: 'Provides access to properties of a vertical coordinate system.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID3f6c2145_3320_446f_82bf_b3e38fadc833
static int	xxDummy Deprecated. Internal use only

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

IID4da0fe00_1dd2_11b2_bf49_08002022f573

Method Summary

ILinearUnit	getCoordinateUnit() The linear unit of a vertical coordinate system.
IHVDatum	getDatum() The datum of a vertical coordinate system.
void	getParameters(IParameter[] parameters) Gets the vertical coordinate system parameters.
int	getPositiveDirection() The positive direction of the z coordinates.
java.lang.String	getUsage() The usage notes of a vertical coordinate system.
double	getVerticalShift() The vertical shift of a vertical coordinate system.
void	setCoordinateUnit(ILinearUnit unit) The linear unit of a vertical coordinate system.
void	setPositiveDirection(int pd) The positive direction of the z coordinates.
void	setVerticalShift(double vshift) The vertical shift of a vertical coordinate system.

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

getAbbreviation, getAlias, getFactoryCode, getName, getRemarks

Field Detail

IID3f6c2145_3320_446f_82bf_b3e38fadc833

static final int IID3f6c2145_3320_446f_82bf_b3e38fadc833

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getUsage

java.lang.String getUsage()
                          throws java.io.IOException,
                                 AutomationException

The usage notes of a vertical coordinate system.

Returns:

The usage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatum

IHVDatum getDatum()
                  throws java.io.IOException,
                         AutomationException

The datum of a vertical coordinate system.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCoordinateUnit

ILinearUnit getCoordinateUnit()
                              throws java.io.IOException,
                                     AutomationException

The linear unit of a vertical coordinate system.

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.

setCoordinateUnit

void setCoordinateUnit(ILinearUnit unit)
                       throws java.io.IOException,
                              AutomationException

The linear unit of a vertical coordinate system.

Parameters:

unit - 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.

getVerticalShift

double getVerticalShift()
                        throws java.io.IOException,
                               AutomationException

The vertical shift of a vertical coordinate system.

Returns:

The vshift

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVerticalShift

void setVerticalShift(double vshift)
                      throws java.io.IOException,
                             AutomationException

The vertical shift of a vertical coordinate system.

Parameters:

vshift - The vshift (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPositiveDirection

int getPositiveDirection()
                         throws java.io.IOException,
                                AutomationException

The positive direction of the z coordinates. Up is 1. Down (in the direction of gravity) is -1.

Returns:

The pd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPositiveDirection

void setPositiveDirection(int pd)
                          throws java.io.IOException,
                                 AutomationException

The positive direction of the z coordinates. Up is 1. Down (in the direction of gravity) is -1.

Parameters:

pd - The pd (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameters

void getParameters(IParameter[] parameters)
                   throws java.io.IOException,
                          AutomationException

Gets the vertical coordinate system parameters.

Parameters:

parameters - A reference to a com.esri.arcgis.geometry.IParameter (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.