Google Git
Sign in
apache / sis-site / refs/heads/javadoc / . / org.apache.sis.util / org / apache / sis / measure / Salinity.html
blob: 9d47cf88f2d94dcdf5d9406d9d9bb0ee920992f2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>Salinity (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.util, package: org.apache.sis.measure, interface: Salinity">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.measure.Salinity interface">
<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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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><a href="#nested-class-summary">Nested</a></li>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</li>
<li>Method</li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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>&nbsp;<a href="../../../../module-summary.html">org.apache.sis.util</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.measure</a></div>
<h1 title="Interface Salinity" class="title">Interface Salinity</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a>&lt;<a href="Salinity.html" title="interface in org.apache.sis.measure">Salinity</a>&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Salinity</span><span class="extends-implements">
extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a>&lt;<a href="Salinity.html" title="interface in org.apache.sis.measure">Salinity</a>&gt;</span></div>
<div class="block">The Practical Salinity Scale (PSS-78).
This is a dimensionless quantity for the measurement of sea water salinity.
In principle, the unit of measurement associated to this quantity has no symbol.
However, Apache SIS uses the "psu" symbol for avoiding confusion with other dimensionless units.
<p><code>Salinity</code> quantities should not be converted to quantities of other types.
If nevertheless a conversion to <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Dimensionless.html" title="class or interface in javax.measure.quantity" class="external-link"><code>Dimensionless</code></a> is attempted,
then Apache SIS implementation maps 1 psu to 1‰ for rough correspondence with legacy
(before 1978) salinity measurements.</p>
<p>Most quantity types are defined in the <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/package-summary.html" class="external-link"><code>javax​.measure​.quantity</code></a>.
This <code>Salinity</code> type is an extension to the standard types.</p></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.8</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="Units.html#PSU"><code>Units​.PSU</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-javax.measure.Quantity">Nested classes/interfaces inherited from interface&nbsp;<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a></h2>
<code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.Scale.html" title="class or interface in javax.measure" class="external-link">Quantity​.Scale</a></code></div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Quantity">Methods inherited from interface&nbsp;<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a></h3>
<code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#add(javax.measure.Quantity)" title="class or interface in javax.measure" class="external-link">add</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#asType(java.lang.Class)" title="class or interface in javax.measure" class="external-link">as­Type</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#divide(java.lang.Number)" title="class or interface in javax.measure" class="external-link">divide</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#divide(javax.measure.Quantity)" title="class or interface in javax.measure" class="external-link">divide</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#getScale()" title="class or interface in javax.measure" class="external-link">get­Scale</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#getUnit()" title="class or interface in javax.measure" class="external-link">get­Unit</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#getValue()" title="class or interface in javax.measure" class="external-link">get­Value</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#inverse()" title="class or interface in javax.measure" class="external-link">inverse</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#isEquivalentTo(javax.measure.Quantity)" title="class or interface in javax.measure" class="external-link">is­Equivalent­To</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#multiply(java.lang.Number)" title="class or interface in javax.measure" class="external-link">multiply</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#multiply(javax.measure.Quantity)" title="class or interface in javax.measure" class="external-link">multiply</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#negate()" title="class or interface in javax.measure" class="external-link">negate</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#subtract(javax.measure.Quantity)" title="class or interface in javax.measure" class="external-link">subtract</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#to(javax.measure.Unit)" title="class or interface in javax.measure" class="external-link">to</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html#toSystemUnit()" title="class or interface in javax.measure" class="external-link">to­System­Unit</a></code></div>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>