blob: 22ff4897268ebe695efccd2582f79607b6c47d68 [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>Parameterized (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.parameter.Parameterized interface">
<meta name="keywords" content="getParameterDescriptors()">
<meta name="keywords" content="getParameterValues()">
<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="Parameterized (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Parameterized.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.parameter</a></div>
<h2 title="Interface Parameterized" class="title">Interface Parameterized</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../referencing/operation/transform/AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">Abstract­Math­Transform</a></code>, <code><a href="../referencing/operation/transform/AbstractMathTransform.Inverse.html" title="class in org.apache.sis.referencing.operation.transform">Abstract­Math­Transform​.Inverse</a></code>, <code><a href="../referencing/operation/transform/AbstractMathTransform1D.html" title="class in org.apache.sis.referencing.operation.transform">Abstract­Math­Transform1D</a></code>, <code><a href="../referencing/operation/transform/AbstractMathTransform1D.Inverse.html" title="class in org.apache.sis.referencing.operation.transform">Abstract­Math­Transform1D​.Inverse</a></code>, <code><a href="../referencing/operation/transform/AbstractMathTransform2D.html" title="class in org.apache.sis.referencing.operation.transform">Abstract­Math­Transform2D</a></code>, <code><a href="../referencing/operation/transform/AbstractMathTransform2D.Inverse.html" title="class in org.apache.sis.referencing.operation.transform">Abstract­Math­Transform2D​.Inverse</a></code>, <code><a href="../referencing/operation/projection/AlbersEqualArea.html" title="class in org.apache.sis.referencing.operation.projection">Albers­Equal­Area</a></code>, <code><a href="../referencing/operation/projection/CylindricalEqualArea.html" title="class in org.apache.sis.referencing.operation.projection">Cylindrical­Equal­Area</a></code>, <code><a href="../referencing/operation/transform/DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">Datum­Shift­Transform</a></code>, <code><a href="../referencing/operation/DefaultConversion.html" title="class in org.apache.sis.referencing.operation">Default­Conversion</a></code>, <code><a href="../referencing/operation/DefaultTransformation.html" title="class in org.apache.sis.referencing.operation">Default­Transformation</a></code>, <code><a href="../referencing/operation/transform/EllipsoidToCentricTransform.html" title="class in org.apache.sis.referencing.operation.transform">Ellipsoid­To­Centric­Transform</a></code>, <code><a href="../referencing/operation/transform/InterpolatedGeocentricTransform.html" title="class in org.apache.sis.referencing.operation.transform">Interpolated­Geocentric­Transform</a></code>, <code><a href="../referencing/operation/transform/InterpolatedMolodenskyTransform.html" title="class in org.apache.sis.referencing.operation.transform">Interpolated­Molodensky­Transform</a></code>, <code><a href="../referencing/operation/transform/InterpolatedTransform.html" title="class in org.apache.sis.referencing.operation.transform">Interpolated­Transform</a></code>, <code><a href="../referencing/operation/projection/LambertConicConformal.html" title="class in org.apache.sis.referencing.operation.projection">Lambert­Conic­Conformal</a></code>, <code><a href="../referencing/operation/projection/Mercator.html" title="class in org.apache.sis.referencing.operation.projection">Mercator</a></code>, <code><a href="../referencing/operation/projection/Mollweide.html" title="class in org.apache.sis.referencing.operation.projection">Mollweide</a></code>, <code><a href="../referencing/operation/transform/MolodenskyTransform.html" title="class in org.apache.sis.referencing.operation.transform">Molodensky­Transform</a></code>, <code><a href="../referencing/operation/projection/NormalizedProjection.html" title="class in org.apache.sis.referencing.operation.projection">Normalized­Projection</a></code>, <code><a href="../referencing/operation/projection/ObliqueMercator.html" title="class in org.apache.sis.referencing.operation.projection">Oblique­Mercator</a></code>, <code><a href="../referencing/operation/projection/ObliqueStereographic.html" title="class in org.apache.sis.referencing.operation.projection">Oblique­Stereographic</a></code>, <code><a href="../referencing/operation/transform/PassThroughTransform.html" title="class in org.apache.sis.referencing.operation.transform">Pass­Through­Transform</a></code>, <code><a href="../referencing/operation/projection/PolarStereographic.html" title="class in org.apache.sis.referencing.operation.projection">Polar­Stereographic</a></code>, <code><a href="../referencing/operation/projection/Polyconic.html" title="class in org.apache.sis.referencing.operation.projection">Polyconic</a></code>, <code><a href="../referencing/operation/projection/Sinusoidal.html" title="class in org.apache.sis.referencing.operation.projection">Sinusoidal</a></code>, <code><a href="../referencing/operation/projection/TransverseMercator.html" title="class in org.apache.sis.referencing.operation.projection">Transverse­Mercator</a></code>, <code><a href="../referencing/operation/projection/ZonedGridSystem.html" title="class in org.apache.sis.referencing.operation.projection">Zoned­Grid­System</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Parameterized</span></pre>
<div class="block">An object which can supply its parameters in a <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>Parameter­Value­Group</code></a>.
All Apache SIS implementations of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform</code></a>
implement this interface.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.5</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">
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterDescriptors()">getParameterDescriptors</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parameter descriptors for this parameterized object, or <code>null</code> if unknown.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterValues()">getParameterValues</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parameter values for this parameterized object, or <code>null</code> if unknown.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getParameterDescriptors()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterDescriptors</h4>
<pre class="methodSignature"><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a>&nbsp;getParameterDescriptors()</pre>
<div class="block">Returns the parameter descriptors for this parameterized object, or <code>null</code> if unknown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter descriptors for this object, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="getParameterValues()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParameterValues</h4>
<pre class="methodSignature"><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a>&nbsp;getParameterValues()</pre>
<div class="block">Returns the parameter values for this parameterized object, or <code>null</code> if unknown.
<div class="section">Modifying parameter values</div>
Unless explicitly allowed by the implementation class, callers should not modify the values
returned by this method. Implementers are encouraged to protect their internal data by returning
an unmodifiable view or a copy of their parameters. If the caller wishes to edit parameter values,
then (s)he should <a href="DefaultParameterValueGroup.html#clone()">clone</a> the parameters before to
modify them, then use the modified parameters for creating a new <code>Parameterized</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parameter values for this object, or <code>null</code> if unknown.</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/Parameterized.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>