com.esri.arcgis.geometry
Interface IVerticalCoordinateSystemGEN

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IVerticalCoordinateSystemGENProxy, VerticalCoordinateSystem

public interface IVerticalCoordinateSystemGEN
extends java.io.Serializable

COM Interface 'IVerticalCoordinateSystemGEN'. 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	IIDd9f23920_ee88_4b14_aa07_a526aa1dfc03
static int	xxDummy Deprecated. Internal use only

Method Summary

ILinearUnit	getCoordinateUnit() The linear unit of measure for the vertical coordinate system.
IHVDatum	getDatum() The vertical or horizontal datum of the vertical coordinate system.
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'.
java.lang.String	getUsage() The usage notes of a vertical coordinate system.
double	getVerticalShift() An offset parameter that changes the origin of the vertical coordinate system.
void	setCoordinateUnit(ILinearUnit unit) The linear unit of measure for the vertical coordinate system.
void	setVerticalShift(double vshift) An offset parameter that changes the origin of the vertical coordinate system.

Field Detail

IIDd9f23920_ee88_4b14_aa07_a526aa1dfc03

static final int IIDd9f23920_ee88_4b14_aa07_a526aa1dfc03

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 vertical or horizontal datum of the 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 measure for the 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 measure for the 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

An offset parameter that changes the origin of the 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

An offset parameter that changes the origin of the 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

A parameter that determines whether the coordinate system is positive 'up' or 'down'. Use -1 for depths (positive down).

Returns:

The pd

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

Retrieves the PositiveDirection and VerticalShift parameters into an array.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.