IVerticalCoordinateSystem Interface

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.

When To Use

Members

	Name	Description
	Abbreviation	The abbreviated name of this spatial reference component.
	Alias	The alias of this spatial reference component.
	CoordinateUnit	The linear unit of a vertical coordinate system.
	Datum	The datum of a vertical coordinate system.
	FactoryCode	The factory code (WKID) of the spatial reference.
	GetParameters	Gets the vertical coordinate system parameters.
	Name	The name of this spatial reference component.
	PositiveDirection	The positive direction of the z coordinates. Up is 1. Down (in the direction of gravity) is -1.
	Remarks	The comment string of this spatial reference component.
	Usage	The usage notes of a vertical coordinate system.
	VerticalShift	The vertical shift of a vertical coordinate system.

IVerticalCoordinateSystem.CoordinateUnit Property

The linear unit of a vertical coordinate system.

Public Property CoordinateUnit As ILinearUnit

public ILinearUnit CoordinateUnit {get; set;}

Description

The unit of measure of the vertical coordinate system. The unit is always be a linear unit such as meters.

IVerticalCoordinateSystem.Datum Property

The datum of a vertical coordinate system.

Public ReadOnly Property Datum As IHVDatum

public IHVDatum Datum {get;}

Description

Retrieves the vertical or horizontal datum of the vertical coordinate system as IHVDatum.

IVerticalCoordinateSystem.GetParameters Method

Gets the vertical coordinate system parameters.

Public Sub GetParameters ( _
    ByRef parameters As IParameter _
)

public void GetParameters (
    ref IParameter parameters
);

Description

Returns the PositiveDirection and VerticalShift parameters in an array of IParameters.

IVerticalCoordinateSystem.PositiveDirection Property

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

Public Property PositiveDirection As Integer

public int PositiveDirection {get; set;}

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.

IVerticalCoordinateSystem.Usage Property

The usage notes of a vertical coordinate system.

Public ReadOnly Property Usage As String

public string Usage {get;}

IVerticalCoordinateSystem.VerticalShift Property

The vertical shift of a vertical coordinate system.

Public Property VerticalShift As Double

public double VerticalShift {get; set;}

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.

Inherited Interfaces

Interfaces	Description
ISpatialReferenceInfo	Provides access to members that control the properties common to all components of a spatial reference system.

Classes that implement IVerticalCoordinateSystem

Classes	Description
VerticalCoordinateSystem	Creates a vertical coordinate system.

ISpatialReferenceFactory3 srFactory = new SpatialReferenceEnvironmentClass();

            IVerticalCoordinateSystem vcs;

            // WGS_1984 is spheroidal

            vcs = srFactory.CreateVerticalCoordinateSystem(115700);

            string csName = vcs.Name; //"WGS_1984"

            ILinearUnit unit = vcs.CoordinateUnit;

            string unitName = unit.Name; //"Meter"