com.esri.arcgis.geometry
Interface IVerticalCoordinateSystem

All Superinterfaces:

ISpatialReferenceInfo, Serializable

All Known Implementing Classes:

VerticalCoordinateSystem

public interface IVerticalCoordinateSystem
extends ISpatialReferenceInfo, Serializable

Provides access to properties of 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.

You can use ISpatialReferenceFactory3 to create a predefined VCS or use the IVerticalCoordinateSystemEdit interface to create a custom VCS.

Product Availability

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

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

Method Detail

getUsage

String getUsage()
                throws IOException,
                       AutomationException

The usage notes of a vertical coordinate system.

Product Availability

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

Returns:

The usage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatum

IHVDatum getDatum()
                  throws IOException,
                         AutomationException

The datum of a 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.

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

ILinearUnit getCoordinateUnit()
                              throws IOException,
                                     AutomationException

The linear unit of a 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.

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

void setCoordinateUnit(ILinearUnit unit)
                       throws IOException,
                              AutomationException

The linear unit of a vertical coordinate system.

Product Availability

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

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

double getVerticalShift()
                        throws IOException,
                               AutomationException

The vertical shift of a 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.

Returns:

The vshift

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalShift

void setVerticalShift(double vshift)
                      throws IOException,
                             AutomationException

The vertical shift of a vertical coordinate system.

Product Availability

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

Parameters:

vshift - The vshift (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPositiveDirection

int getPositiveDirection()
                         throws IOException,
                                AutomationException

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

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.

Returns:

The pd

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPositiveDirection

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.

Parameters:

pd - The pd (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

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.

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.