This document is archived and information here might be outdated.  Recommended version.


IVerticalCoordinateSystemGEN Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Geometry)  

IVerticalCoordinateSystemGEN Interface

Provides access to properties of a vertical coordinate system.

Product Availability

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

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.

Members

Description
Read/write property CoordinateUnit The linear unit of measure for the vertical coordinate system.
Read-only property Datum The vertical or horizontal datum of the vertical coordinate system.
Method GetParameters Retrieves the PositiveDirection and VerticalShift parameters into an array.
Read-only property PositiveDirection A parameter that determines whether the coordinate system is positive 'up' or 'down'. Use -1 for depths (positive down).
Read-only property Usage The usage notes of a vertical coordinate system.
Read/write property VerticalShift An offset parameter that changes the origin of the vertical coordinate system.

CoClasses that implement IVerticalCoordinateSystemGEN

CoClasses and Classes Description
VerticalCoordinateSystem Creates a vertical coordinate system.