Google Git
Sign in
apache / sis-site / 3eac6c6ff79f5984196de5b19972dbd5b7f38c79 / . / static / apidocs / org / apache / sis / referencing / CommonCRS.Vertical.html
blob: 20eef02445089210692f5b9814570cb1a6623d00 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>CommonCRS.Vertical (Apache SIS 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2019-09-20">
<meta name="keywords" content="org.apache.sis.referencing.CommonCRS.Vertical class">
<meta name="keywords" content="values()">
<meta name="keywords" content="valueOf()">
<meta name="keywords" content="crs()">
<meta name="keywords" content="datum()">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommonCRS.Vertical (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CommonCRS.Vertical.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing</a></div>
<h2 title="Enum CommonCRS.Vertical" class="title">Enum CommonCRS.Vertical</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a>&gt;</li>
<li>
<ul class="inheritance">
<li>Vertical</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a>&lt;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">Common­CRS​.Vertical</a>&gt;</code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="CommonCRS.html" title="enum in org.apache.sis.referencing">CommonCRS</a></dd>
</dl>
<hr>
<pre>public static enum <span class="typeNameLabel">CommonCRS.Vertical</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a>&gt;</pre>
<div class="block">Frequently-used vertical CRS and datum that are guaranteed to be available in SIS.
Methods in this enumeration are shortcuts for object definitions in the EPSG database.
If there is no EPSG database available, or if the query failed, or if there is no EPSG definition for an object,
then <code>Vertical</code> fallback on hard-coded values. Consequently, those methods never return <code>null</code>.
<p>Referencing objects are cached after creation. Invoking the same method on the same <code>Vertical</code>
instance twice will return the same <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>Identified­Object</code></a> instance, unless the internal cache has been cleared
(e.g. the application is running in a container environment and some modules have been installed or uninstalled).</p>
<p><b>Example:</b> the following code fetches a vertical Coordinate Reference System for heights
above the Mean Sea Level (MSL):</p>
<blockquote><pre>VerticalCRS crs = CommonCRS.Vertical.MEAN_SEA_LEVEL.<b>crs</b>();</pre></blockquote>
Below is an alphabetical list of object names available in this enumeration:
<blockquote><table class="sis">
<caption>Geodetic objects accessible by enumeration constants</caption>
<tr><th>Name or alias</th> <th>Object type</th> <th>Enumeration value</th></tr>
<tr><td>Barometric altitude</td> <td>CRS, Datum</td> <td><a href="#BAROMETRIC"><code>BAROMETRIC</code></a></td></tr>
<!-- <s>Ellipsoidal height</s> intentionally omitted <td><s>{@link #ELLIPSOIDAL}</s></td> -->
<tr><td>Mean Sea Level</td> <td>Datum</td> <td><a href="#MEAN_SEA_LEVEL"><code>MEAN_SEA_LEVEL</code></a></td></tr>
<tr><td>Mean Sea Level depth</td> <td>CRS</td> <td><a href="#DEPTH"><code>DEPTH</code></a></td></tr>
<tr><td>Mean Sea Level height</td> <td>CRS</td> <td><a href="#MEAN_SEA_LEVEL"><code>MEAN_SEA_LEVEL</code></a></td></tr>
<tr><td>NAVD88 height</td> <td>CRS</td> <td><a href="#NAVD88"><code>NAVD88</code></a></td></tr>
<tr><td>North American Vertical Datum 1988</td> <td>Datum</td> <td><a href="#NAVD88"><code>NAVD88</code></a></td></tr>
<tr><td>Other surface</td> <td>CRS, Datum</td> <td><a href="#OTHER_SURFACE"><code>OTHER_SURFACE</code></a></td></tr>
</table></blockquote>
<div class="note"><b>Note:</b>
We do not provide a <code>GEOIDAL</code> value because its definition depends on the realization epoch.
For example EGM84, EGM96 and EGM2008 are applications of three different geoid models on the WGS 84 ellipsoid.
The <a href="#MEAN_SEA_LEVEL"><code>MEAN_SEA_LEVEL</code></a> value can be used instead as an approximation of geoidal heights.</div></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="factory/CommonAuthorityFactory.html" title="class in org.apache.sis.referencing.factory"><code>Common­Authority­Factory</code></a></dd>
<p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#BAROMETRIC">BAROMETRIC</a></span></code></th>
<td class="colLast">
<div class="block">Height measured by atmospheric pressure in hectopascals (hPa).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DEPTH">DEPTH</a></span></code></th>
<td class="colLast">
<div class="block">Depth measured below the Mean Sea Level (MSL) in metres.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ELLIPSOIDAL">ELLIPSOIDAL</a></span></code></th>
<td class="colLast">
<div class="block">Height measured along the normal to the ellipsoid used in the definition of horizontal datum.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MEAN_SEA_LEVEL">MEAN_SEA_LEVEL</a></span></code></th>
<td class="colLast">
<div class="block">Height measured above the Mean Sea Level (MSL) in metres.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NAVD88">NAVD88</a></span></code></th>
<td class="colLast">
<div class="block">North American Vertical Datum 1988 height.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OTHER_SURFACE">OTHER_SURFACE</a></span></code></th>
<td class="colLast">
<div class="block">Height measured above other kind of surface, for example a geological feature.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/VerticalCRS.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">VerticalCRS</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#crs()">crs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the coordinate reference system associated to this vertical object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/VerticalDatum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">VerticalDatum</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#datum()">datum</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the datum associated to this vertical object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang" class="externalLink">compare­To</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang" class="externalLink">get­Declaring­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hash­Code</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang" class="externalLink">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang" class="externalLink">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">to­String</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink">value­Of</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notify­All</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="BAROMETRIC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BAROMETRIC</h4>
<pre>public static final&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a> BAROMETRIC</pre>
<div class="block">Height measured by atmospheric pressure in hectopascals (hPa).
Hectopascals are the units of measurement used by the worldwide meteorological community.
The datum is not specific to any location or epoch.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/VerticalDatumType.html?is-external=true#BAROMETRIC" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Vertical­Datum­Type​.BAROMETRIC</code></a></dd>
</dl>
</li>
</ul>
<a id="MEAN_SEA_LEVEL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MEAN_SEA_LEVEL</h4>
<pre>public static final&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a> MEAN_SEA_LEVEL</pre>
<div class="block">Height measured above the Mean Sea Level (MSL) in metres. Can be used as an approximation of geoidal heights
(height measured above an equipotential surface), except that MSL are not specific to any location or epoch.
<blockquote><table class="compact">
<caption>Mean Sea Level properties</caption>
<tr><th>EPSG identifiers:</th> <td>5714 &nbsp;(<i>datum:</i> 5100)</td></tr>
<tr><th>Primary names:</th> <td>"MSL height" &nbsp;(<i>datum:</i> "Mean Sea Level")</td></tr>
<tr><th>Abbreviations or aliases:</th> <td>"mean sea level height" &nbsp;(<i>datum:</i> "MSL")</td></tr>
<tr><th>Direction:</th> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#UP" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>AxisDirection.UP</code></a></td></tr>
<tr><th>Unit:</th> <td><a href="../measure/Units.html#METRE"><code>Units.METRE</code></a></td></tr>
</table></blockquote></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/VerticalDatumType.html?is-external=true#GEOIDAL" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Vertical­Datum­Type​.GEOIDAL</code></a></dd>
</dl>
</li>
</ul>
<a id="DEPTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEPTH</h4>
<pre>public static final&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a> DEPTH</pre>
<div class="block">Depth measured below the Mean Sea Level (MSL) in metres.
<blockquote><table class="compact">
<caption>Depth properties</caption>
<tr><th>EPSG identifiers:</th> <td>5715 &nbsp;(<i>datum:</i> 5100)</td></tr>
<tr><th>Primary names:</th> <td>"MSL depth" &nbsp;(<i>datum:</i> "Mean Sea Level")</td></tr>
<tr><th>Abbreviations or aliases:</th> <td>"mean sea level depth" &nbsp;(<i>datum:</i> "MSL")</td></tr>
<tr><th>Direction:</th> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#DOWN" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>AxisDirection.DOWN</code></a></td></tr>
<tr><th>Unit:</th> <td><a href="../measure/Units.html#METRE"><code>Units.METRE</code></a></td></tr>
</table></blockquote></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/VerticalDatumType.html?is-external=true#GEOIDAL" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Vertical­Datum­Type​.GEOIDAL</code></a></dd>
</dl>
</li>
</ul>
<a id="NAVD88">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NAVD88</h4>
<pre>public static final&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a> NAVD88</pre>
<div class="block">North American Vertical Datum 1988 height.
<blockquote><table class="compact">
<caption>NAVD88 properties</caption>
<tr><th>WMS identifier:</th> <td>CRS:88</td></tr>
<tr><th>EPSG identifiers:</th> <td>5703 &nbsp;(<i>datum:</i> 5103)</td></tr>
<tr><th>Primary names:</th> <td>"NAVD88 height" &nbsp;(<i>datum:</i> "North American Vertical Datum 1988")</td></tr>
<tr><th>Abbreviations or aliases:</th> <td>" North American Vertical Datum of 1988 height (m)" &nbsp;(<i>datum:</i> "NAVD88")</td></tr>
<tr><th>Direction:</th> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#UP" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>AxisDirection.UP</code></a></td></tr>
<tr><th>Unit:</th> <td><a href="../measure/Units.html#METRE"><code>Units.METRE</code></a></td></tr>
</table></blockquote></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.7</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="CommonCRS.html#NAD83"><code>Common­CRS​.NAD83</code></a></dd>
</dl>
</li>
</ul>
<a id="ELLIPSOIDAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELLIPSOIDAL</h4>
<pre>public static final&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a> ELLIPSOIDAL</pre>
<div class="block">Height measured along the normal to the ellipsoid used in the definition of horizontal datum.
The unit of measurement is metres.
<p><b>Ellipsoidal height is not part of ISO 19111 international standard.</b>
Such vertical CRS is usually not recommended since ellipsoidal heights make little sense without
their (<var>latitude</var>, <var>longitude</var>) locations. The ISO specification defines instead
three-dimensional <code>Geographic­CRS</code> for that reason. Users are encouraged to avoid this orphan
ellipsoidal height as much as possible.</p></div>
</li>
</ul>
<a id="OTHER_SURFACE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OTHER_SURFACE</h4>
<pre>public static final&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a> OTHER_SURFACE</pre>
<div class="block">Height measured above other kind of surface, for example a geological feature.
The unit of measurement is metres.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/VerticalDatumType.html?is-external=true#OTHER_SURFACE" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Vertical­Datum­Type​.OTHER_SURFACE</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (CommonCRS.Vertical c : CommonCRS.Vertical.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="CommonCRS.Vertical.html" title="enum in org.apache.sis.referencing">CommonCRS.Vertical</a>&nbsp;valueOf&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­Argument­Exception</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Null­Pointer­Exception</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a id="crs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>crs</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/VerticalCRS.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">VerticalCRS</a>&nbsp;crs()</pre>
<div class="block">Returns the coordinate reference system associated to this vertical object.
The following table summarizes the CRS known to this class,
together with an enumeration value that can be used for fetching that CRS:
<blockquote><table class="sis">
<caption>Commonly used vertical CRS</caption>
<tr><th>Name or alias</th> <th>Enum</th> <th>EPSG</th></tr>
<tr><td>Barometric altitude</td> <td><a href="#BAROMETRIC"><code>BAROMETRIC</code></a></td> <td></td></tr>
<!-- <s>Ellipsoidal height</s> intentionally omitted -->
<tr><td>Mean Sea Level depth</td> <td><a href="#DEPTH"><code>DEPTH</code></a></td> <td>5715</td></tr>
<tr><td>Mean Sea Level height</td> <td><a href="#MEAN_SEA_LEVEL"><code>MEAN_SEA_LEVEL</code></a></td> <td>5714</td></tr>
<tr><td>Other surface</td> <td><a href="#OTHER_SURFACE"><code>OTHER_SURFACE</code></a></td> <td></td></tr>
</table></blockquote></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the CRS associated to this enum.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="crs/DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs"><code>Default­Vertical­CRS</code></a></dd>
</dl>
</li>
</ul>
<a id="datum()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>datum</h4>
<pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/VerticalDatum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink">VerticalDatum</a>&nbsp;datum()</pre>
<div class="block">Returns the datum associated to this vertical object.
The following table summarizes the datum known to this class,
together with an enumeration value that can be used for fetching that datum:
<blockquote><table class="sis">
<caption>Commonly used vertical datum</caption>
<tr><th>Name or alias</th> <th>Enum</th> <th>EPSG</th></tr>
<tr><td>Barometric altitude</td> <td><a href="#BAROMETRIC"><code>BAROMETRIC</code></a></td> <td></td></tr>
<!-- <s>Ellipsoidal height</s> intentionally omitted -->
<tr><td>Mean Sea Level</td> <td><a href="#MEAN_SEA_LEVEL"><code>MEAN_SEA_LEVEL</code></a></td> <td>5100</td></tr>
<tr><td>Other surface</td> <td><a href="#OTHER_SURFACE"><code>OTHER_SURFACE</code></a></td> <td></td></tr>
</table></blockquote></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the datum associated to this enum.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="datum/DefaultVerticalDatum.html" title="class in org.apache.sis.referencing.datum"><code>Default­Vertical­Datum</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CommonCRS.Vertical.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>