| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>DefaultVerticalCRS (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.referencing, package: org.apache.sis.referencing.crs, class: DefaultVerticalCRS"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.referencing.crs.DefaultVerticalCRS class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="getInterface()"> |
| <meta name="keywords" content="getDatum()"> |
| <meta name="keywords" content="getCoordinateSystem()"> |
| <meta name="keywords" content="forConvention()"> |
| <meta name="keywords" content="formatTo()"> |
| <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="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.referencing.crs</a></div> |
| <h1 title="Class DefaultVerticalCRS" class="title">Class DefaultVerticalCRS</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a> |
| <div class="inheritance"><a href="../AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a> |
| <div class="inheritance"><a href="../AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a> |
| <div class="inheritance"><a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a> |
| <div class="inheritance">DefaultVerticalCRS</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Formattable.html" title="class or interface in java.util" class="external-link">Formattable</a></code>, <code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code>, <code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html" title="class or interface in org.opengis.referencing" class="external-link">ReferenceSystem</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultVerticalCRS</span> |
| <span class="extends-implements">extends <a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a></span></div> |
| <div class="block">A 1-dimensional coordinate reference system used for recording heights or depths. |
| Vertical CRSs make use of the direction of gravity to define the concept of height or depth, |
| but the relationship with gravity may not be straightforward. |
| |
| <p><b>Used with datum type:</b> |
| <a href="../datum/DefaultVerticalDatum.html" title="class in org.apache.sis.referencing.datum">Vertical</a>.<br> |
| <b>Used with coordinate system type:</b> |
| <a href="../cs/DefaultVerticalCS.html" title="class in org.apache.sis.referencing.cs">Vertical</a>. |
| </p> |
| |
| <h2 id="immutability-and-thread-safety-heading">Immutability and thread safety</h2> |
| This class is immutable and thus thread-safe if the property <em>values</em> (not necessarily the map itself), |
| the coordinate system and the datum instances given to the constructor are also immutable. Unless otherwise noted |
| in the javadoc, this condition holds if all components were created using only SIS factories and static constants.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="../datum/DefaultVerticalDatum.html" title="class in org.apache.sis.referencing.datum"><code>DefaultVerticalDatum</code></a></li> |
| <li><a href="../cs/DefaultVerticalCS.html" title="class in org.apache.sis.referencing.cs"><code>DefaultVerticalCS</code></a></li> |
| <li><a href="../factory/GeodeticAuthorityFactory.html#createVerticalCRS(java.lang.String)"><code>GeodeticAuthorityFactory.createVerticalCRS(String)</code></a></li> |
| <li><a href="../../../../../../serialized-form.html#org.apache.sis.referencing.crs.DefaultVerticalCRS">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-AbstractIdentifiedObject">Fields inherited from class <a href="../AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3> |
| <code><a href="../AbstractIdentifiedObject.html#DEPRECATED_KEY">DEPRECATED_KEY</a>, <a href="../AbstractIdentifiedObject.html#LOCALE_KEY">LOCALE_KEY</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-IdentifiedObject">Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">ALIAS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">IDENTIFIERS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">NAME_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">REMARKS_KEY</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-ReferenceSystem">Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html" title="class or interface in org.opengis.referencing" class="external-link">ReferenceSystem</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#DOMAIN_OF_VALIDITY_KEY" title="class or interface in org.opengis.referencing" class="external-link">DOMAIN_OF_VALIDITY_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#SCOPE_KEY" title="class or interface in org.opengis.referencing" class="external-link">SCOPE_KEY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map,org.opengis.referencing.datum.VerticalDatum,org.opengis.referencing.cs.VerticalCS)" class="member-name-link">DefaultVerticalCRS</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/VerticalDatum.html" title="class or interface in org.opengis.referencing.datum" class="external-link">VerticalDatum</a> datum, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/VerticalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link">VerticalCS</a> cs)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a coordinate reference system from the given properties, datum and coordinate system.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.opengis.referencing.crs.VerticalCRS)" class="member-name-link">DefaultVerticalCRS</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a> crs)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a new coordinate reference system with the same values than the specified one.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultVerticalCRS</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#castOrCopy(org.opengis.referencing.crs.VerticalCRS)" class="member-name-link">castOrCopy</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a> object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a SIS coordinate reference system implementation with the same values than the given |
| arbitrary implementation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultVerticalCRS</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#forConvention(org.apache.sis.referencing.cs.AxesConvention)" class="member-name-link">forConvention</a><wbr>(<a href="../cs/AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a> convention)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a coordinate reference system equivalent to this one but with axes rearranged according the given |
| convention.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatTo(org.apache.sis.io.wkt.Formatter)" class="member-name-link">formatTo</a><wbr>(<a href="../../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a> formatter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats this CRS as a <cite>Well Known Text</cite> <code>VerticalCRS[…]</code> element.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/VerticalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link">VerticalCS</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoordinateSystem()" class="member-name-link">getCoordinateSystem</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the coordinate system.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/VerticalDatum.html" title="class or interface in org.opengis.referencing.datum" class="external-link">VerticalDatum</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDatum()" class="member-name-link">getDatum</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the datum.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInterface()" class="member-name-link">getInterface</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the GeoAPI interface implemented by this class.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractCRS">Methods inherited from class <a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></h3> |
| <code><a href="AbstractCRS.html#castOrCopy(org.opengis.referencing.crs.CoordinateReferenceSystem)">castOrCopy</a>, <a href="AbstractCRS.html#computeHashCode()">computeHashCode</a>, <a href="AbstractCRS.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractReferenceSystem">Methods inherited from class <a href="../AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></h3> |
| <code><a href="../AbstractReferenceSystem.html#getDomainOfValidity()">getDomainOfValidity</a>, <a href="../AbstractReferenceSystem.html#getScope()">getScope</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractIdentifiedObject">Methods inherited from class <a href="../AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3> |
| <code><a href="../AbstractIdentifiedObject.html#castOrCopy(org.opengis.referencing.IdentifiedObject)">castOrCopy</a>, <a href="../AbstractIdentifiedObject.html#equals(java.lang.Object)">equals</a>, <a href="../AbstractIdentifiedObject.html#formatTo(java.util.Formatter,int,int,int)">formatTo</a>, <a href="../AbstractIdentifiedObject.html#getAlias()">getAlias</a>, <a href="../AbstractIdentifiedObject.html#getDescription()">getDescription</a>, <a href="../AbstractIdentifiedObject.html#getDomains()">getDomains</a>, <a href="../AbstractIdentifiedObject.html#getIdentifiers()">getIdentifiers</a>, <a href="../AbstractIdentifiedObject.html#getName()">getName</a>, <a href="../AbstractIdentifiedObject.html#getRemarks()">getRemarks</a>, <a href="../AbstractIdentifiedObject.html#hashCode()">hashCode</a>, <a href="../AbstractIdentifiedObject.html#isDeprecated()">isDeprecated</a>, <a href="../AbstractIdentifiedObject.html#isHeuristicMatchForName(java.lang.String)">isHeuristicMatchForName</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-FormattableObject">Methods inherited from class <a href="../../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3> |
| <code><a href="../../io/wkt/FormattableObject.html#print()">print</a>, <a href="../../io/wkt/FormattableObject.html#toString()">toString</a>, <a href="../../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../../io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-IdentifiedObject">Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getAlias()" title="class or interface in org.opengis.referencing" class="external-link">getAlias</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getIdentifiers()" title="class or interface in org.opengis.referencing" class="external-link">getIdentifiers</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getName()" title="class or interface in org.opengis.referencing" class="external-link">getName</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getRemarks()" title="class or interface in org.opengis.referencing" class="external-link">getRemarks</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#toWKT()" title="class or interface in org.opengis.referencing" class="external-link">toWKT</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-ReferenceSystem">Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html" title="class or interface in org.opengis.referencing" class="external-link">ReferenceSystem</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#getDomainOfValidity()" title="class or interface in org.opengis.referencing" class="external-link">getDomainOfValidity</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#getScope()" title="class or interface in org.opengis.referencing" class="external-link">getScope</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.util.Map,org.opengis.referencing.datum.VerticalDatum,org.opengis.referencing.cs.VerticalCS)"> |
| <h3>DefaultVerticalCRS</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultVerticalCRS</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/VerticalDatum.html" title="class or interface in org.opengis.referencing.datum" class="external-link">VerticalDatum</a> datum, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/VerticalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link">VerticalCS</a> cs)</span></div> |
| <div class="block">Creates a coordinate reference system from the given properties, datum and coordinate system. |
| The properties given in argument follow the same rules than for the |
| <a href="../AbstractReferenceSystem.html#%3Cinit%3E(java.util.Map)">super-class constructor</a>. |
| The following table is a reminder of main (not all) properties: |
| |
| <table class="sis"> |
| <caption>Recognized properties (non exhaustive list)</caption> |
| <tr> |
| <th>Property name</th> |
| <th>Value type</th> |
| <th>Returned by</th> |
| </tr><tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">"name"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceIdentifier.html" title="class or interface in org.opengis.referencing" class="external-link"><code>ReferenceIdentifier</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a></td> |
| </tr><tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"alias"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link"><code>CharSequence</code></a> (optionally as array)</td> |
| <td><a href="../AbstractIdentifiedObject.html#getAlias()"><code>AbstractIdentifiedObject.getAlias()</code></a></td> |
| </tr><tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"identifiers"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceIdentifier.html" title="class or interface in org.opengis.referencing" class="external-link"><code>ReferenceIdentifier</code></a> (optionally as array)</td> |
| <td><a href="../AbstractIdentifiedObject.html#getIdentifiers()"><code>AbstractIdentifiedObject.getIdentifiers()</code></a></td> |
| </tr><tr> |
| <td>"domains"</td> |
| <td><a href="../DefaultObjectDomain.html" title="class in org.apache.sis.referencing"><code>DefaultObjectDomain</code></a> (optionally as array)</td> |
| <td><a href="../AbstractIdentifiedObject.html#getDomains()"><code>AbstractIdentifiedObject.getDomains()</code></a></td> |
| </tr><tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"remarks"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../AbstractIdentifiedObject.html#getRemarks()"><code>AbstractIdentifiedObject.getRemarks()</code></a></td> |
| </tr> |
| </table></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - the properties to be given to the coordinate reference system.</dd> |
| <dd><code>datum</code> - the datum.</dd> |
| <dd><code>cs</code> - the coordinate system.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="../factory/GeodeticObjectFactory.html#createVerticalCRS(java.util.Map,org.opengis.referencing.datum.VerticalDatum,org.opengis.referencing.cs.VerticalCS)"><code>GeodeticObjectFactory.createVerticalCRS(Map, VerticalDatum, VerticalCS)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.opengis.referencing.crs.VerticalCRS)"> |
| <h3>DefaultVerticalCRS</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">DefaultVerticalCRS</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a> crs)</span></div> |
| <div class="block">Constructs a new coordinate reference system with the same values than the specified one. |
| This copy constructor provides a way to convert an arbitrary implementation into a SIS one |
| or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. |
| |
| <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system to copy.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#castOrCopy(org.opengis.referencing.crs.VerticalCRS)"><code>castOrCopy(VerticalCRS)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="castOrCopy(org.opengis.referencing.crs.VerticalCRS)"> |
| <h3>castOrCopy</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultVerticalCRS</a></span> <span class="element-name">castOrCopy</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a> object)</span></div> |
| <div class="block">Returns a SIS coordinate reference system implementation with the same values than the given |
| arbitrary implementation. If the given object is <code>null</code>, then this method returns <code>null</code>. |
| Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. |
| Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd>a SIS implementation containing the values of the given object (may be the |
| given object itself), or <code>null</code> if the argument was null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInterface()"> |
| <h3>getInterface</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a>></span> <span class="element-name">getInterface</span>()</div> |
| <div class="block">Returns the GeoAPI interface implemented by this class. |
| The SIS implementation returns <code>VerticalCRS.class</code>. |
| |
| <h4 id="note-for-implementers-heading">Note for implementers</h4> |
| Subclasses usually do not need to override this method since GeoAPI does not define <code>VerticalCRS</code> |
| sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their |
| own set of interfaces.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractCRS.html#getInterface()">getInterface</a></code> in class <code><a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>VerticalCRS.class</code> or a user-defined sub-interface.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDatum()"> |
| <h3>getDatum</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/VerticalDatum.html" title="class or interface in org.opengis.referencing.datum" class="external-link">VerticalDatum</a></span> <span class="element-name">getDatum</span>()</div> |
| <div class="block">Returns the datum.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html#getDatum()" title="class or interface in org.opengis.referencing.crs" class="external-link">getDatum</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html#getDatum()" title="class or interface in org.opengis.referencing.crs" class="external-link">getDatum</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the datum.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCoordinateSystem()"> |
| <h3>getCoordinateSystem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/VerticalCS.html" title="class or interface in org.opengis.referencing.cs" class="external-link">VerticalCS</a></span> <span class="element-name">getCoordinateSystem</span>()</div> |
| <div class="block">Returns the coordinate system.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html#getCoordinateSystem()" title="class or interface in org.opengis.referencing.crs" class="external-link">getCoordinateSystem</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html#getCoordinateSystem()" title="class or interface in org.opengis.referencing.crs" class="external-link">getCoordinateSystem</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html#getCoordinateSystem()" title="class or interface in org.opengis.referencing.crs" class="external-link">getCoordinateSystem</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractCRS.html#getCoordinateSystem()">getCoordinateSystem</a></code> in class <code><a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the coordinate system.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forConvention(org.apache.sis.referencing.cs.AxesConvention)"> |
| <h3>forConvention</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultVerticalCRS</a></span> <span class="element-name">forConvention</span><wbr><span class="parameters">(<a href="../cs/AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a> convention)</span></div> |
| <div class="block">Returns a coordinate reference system equivalent to this one but with axes rearranged according the given |
| convention. If this CRS is already compatible with the given convention, then this method returns <code>this</code>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractCRS.html#forConvention(org.apache.sis.referencing.cs.AxesConvention)">forConvention</a></code> in class <code><a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>convention</code> - the axes convention for which a coordinate reference system is desired.</dd> |
| <dt>Returns:</dt> |
| <dd>a coordinate reference system compatible with the given convention (may be <code>this</code>).</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="../cs/AbstractCS.html#forConvention(org.apache.sis.referencing.cs.AxesConvention)"><code>AbstractCS.forConvention(AxesConvention)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatTo(org.apache.sis.io.wkt.Formatter)"> |
| <h3>formatTo</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">formatTo</span><wbr><span class="parameters">(<a href="../../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a> formatter)</span></div> |
| <div class="block">Formats this CRS as a <cite>Well Known Text</cite> <code>VerticalCRS[…]</code> element.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractCRS.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a></code> in class <code><a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>formatter</code> - the formatter where to format the inner content of this WKT element.</dd> |
| <dt>Returns:</dt> |
| <dd><code>"VerticalCRS"</code> (WKT 2) or <code>"Vert_CS"</code> (WKT 1).</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#69">WKT 2 specification §10</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |