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

Members

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

IVerticalCoordinateSystemGEN.CoordinateUnit Property

The linear unit of measure for the 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.

IVerticalCoordinateSystemGEN.Datum Property

The vertical or horizontal datum of the 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.

IVerticalCoordinateSystemGEN.GetParameters Method

Retrieves the PositiveDirection and VerticalShift parameters into an array.

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.

IVerticalCoordinateSystemGEN.PositiveDirection Property

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

Public ReadOnly Property PositiveDirection As Integer
public int PositiveDirection {get;}

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.

IVerticalCoordinateSystemGEN.Usage Property

The usage notes of a vertical coordinate system.

Public ReadOnly Property Usage As String
public string Usage {get;}

IVerticalCoordinateSystemGEN.VerticalShift Property

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

Classes that implement IVerticalCoordinateSystemGEN

Classes Description
VerticalCoordinateSystem Creates a vertical coordinate system.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.