com.esri.arcgis.geometry
Interface IVerticalCoordinateSystemEdit

All Superinterfaces:

Serializable

All Known Implementing Classes:

VerticalCoordinateSystem

public interface IVerticalCoordinateSystemEdit
extends Serializable

Provides access to members that control the 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. 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.

Method Summary

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.

Method Detail

define

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.

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.