blob: 0b868ca78dcc68f1a718baa9d39c2ae37e03bb55 [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>MilitaryGridReferenceSystem (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.gazetteer.MilitaryGridReferenceSystem class">
<meta name="keywords" content="createCoder()">
<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="MilitaryGridReferenceSystem (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10};
var tabs = {65535:["t0","All 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/MilitaryGridReferenceSystem.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.gazetteer</a></div>
<h2 title="Class MilitaryGridReferenceSystem" class="title">Class MilitaryGridReferenceSystem</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="../../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></li>
<li>
<ul class="inheritance">
<li><a href="../AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></li>
<li>
<ul class="inheritance">
<li><a href="../AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></li>
<li>
<ul class="inheritance">
<li><a href="ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers</a></li>
<li>
<ul class="inheritance">
<li>MilitaryGridReferenceSystem</li>
</ul>
</li>
</ul>
</li>
</ul>
</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="../../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code>, <code><a href="../../util/LenientComparable.html" title="interface in org.apache.sis.util">Lenient­Comparable</a></code>, <code><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">Identified­Object</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">Reference­System</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">MilitaryGridReferenceSystem</span>
extends <a href="ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers</a></pre>
<div class="block">The Military Grid Reference System (MGRS).
The MGRS is the geocoordinate standard used by NATO militaries for locating points on the earth.
It is based on the Universal Transverse Mercator (UTM) and the Universal Polar Stereographic (UPS) projections.
Despite its name, MGRS is used not only for military purposes; it is used also for organizing Earth Observation
data in directory trees for example.
<p>MGRS references are sequences of digits and letters like “4Q FJ 12345 67890” (a reference with 1 metre accuracy),
optionally written with reduced resolution as in “4Q FJ 123 678” (a reference with 100 metres accuracy).
Those references form a hierarchy of 3 <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">location types</a>:</p>
<blockquote>
<b>Grid zone designator</b> (example: “4Q”)<br>
   └─<b>100 km square identifier</b> (example: “FJ”)<br>
       └─<b>Grid coordinate</b> (example: “12345 67890”)<br>
</blockquote>
<p>Conversions between MGRS references and spatial coordinates can be performed by the <a href="MilitaryGridReferenceSystem.Coder.html" title="class in org.apache.sis.referencing.gazetteer"><code>Coder</code></a> inner class.
The result of decoding a MGRS reference is an envelope rather than a point, but a representative point can be obtained.
The encoding and decoding processes take in account Norway and Svalbard special cases (they have wider UTM zones for
historical reasons).</p>
<div class="note"><b>Example:</b>
the following code:
<blockquote><pre>MilitaryGridReferenceSystem system = <font color="green">new</font> <b>MilitaryGridReferenceSystem</b>();
MilitaryGridReferenceSystem.Coder coder = system.<b>createCoder</b>();
Location loc = coder.<b>decode</b>(<font color="orangered">"32TNL83"</font>);
System.out.<b>println</b>(loc);</pre></blockquote>
should display (locale may vary):
<blockquote><pre>┌─────────────────────────────────────────────────────────────────┐
│ Location type: Grid coordinate │
│ Geographic identifier: 32TNL83 │
│ West bound: 580,000 m — 9°57′00″E │
│ Representative value: 585,000 m — 10°00′36″E │
│ East bound: 590,000 m — 10°04′13″E │
│ South bound: 4,530,000 m — 40°54′58″N │
│ Representative value: 4,535,000 m — 40°57′42″N │
│ North bound: 4,540,000 m — 41°00′27″N │
│ Coordinate reference system: WGS 84 / UTM zone 32N │
│ Administrator: North Atlantic Treaty Organization │
└─────────────────────────────────────────────────────────────────┘</pre></blockquote>
</div>
<div class="section">Immutability and thread safety</div>
This class is immutable and thus thread-safe.
However the <a href="MilitaryGridReferenceSystem.Coder.html" title="class in org.apache.sis.referencing.gazetteer"><code>Coder</code></a> instances performing conversions between references and coordinates
are not thread-safe; it is recommended to create a new <code>Coder</code> instance for each thread.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.8</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../CommonCRS.html#universal(double,double)"><code>Common­CRS​.universal(double, double)</code></a>,
<a href="https://en.wikipedia.org/wiki/Military_Grid_Reference_System">Military Grid Reference System on Wikipedia</a>,
<a href="../../../../../serialized-form.html#org.apache.sis.referencing.gazetteer.MilitaryGridReferenceSystem">Serialized Form</a></dd>
<p><font size="-1">Defined in the <code>sis-referencing-by-identifiers</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MilitaryGridReferenceSystem.Coder.html" title="class in org.apache.sis.referencing.gazetteer">MilitaryGridReferenceSystem.Coder</a></span></code></th>
<td class="colLast">
<div class="block">Conversions between direct positions and references in the Military Grid Reference System (MGRS).</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.ReferencingByIdentifiers">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;<a href="ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers</a></h3>
<code><a href="ReferencingByIdentifiers.html#OVERALL_OWNER_KEY">OVERALL_OWNER_KEY</a>, <a href="ReferencingByIdentifiers.html#THEME_KEY">THEME_KEY</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.AbstractIdentifiedObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.IdentifiedObject">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;<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">IdentifiedObject</a></h3>
<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">ALIAS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">IDENTIFIERS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#NAME_KEY" title="class or interface in org.opengis.referencing" class="externalLink">NAME_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">REMARKS_KEY</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.ReferenceSystem">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceSystem</a></h3>
<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true#DOMAIN_OF_VALIDITY_KEY" title="class or interface in org.opengis.referencing" class="externalLink">DOMAIN_OF_VALIDITY_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true#SCOPE_KEY" title="class or interface in org.opengis.referencing" class="externalLink">SCOPE_KEY</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">MilitaryGridReferenceSystem</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new Military Grid Reference System (MGRS) using the default datum.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,org.apache.sis.referencing.CommonCRS)">MilitaryGridReferenceSystem</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;?&gt;&nbsp;properties,
<a href="../CommonCRS.html" title="enum in org.apache.sis.referencing">CommonCRS</a>&nbsp;datum)</code></th>
<td class="colLast">
<div class="block">Creates a new Military Grid Reference System (MGRS) using the specified datum.</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="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="MilitaryGridReferenceSystem.Coder.html" title="class in org.apache.sis.referencing.gazetteer">MilitaryGridReferenceSystem.Coder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCoder()">createCoder</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a new object performing conversions between <code>Direct­Position</code> and MGRS references.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.ReferencingByIdentifiers">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers</a></h3>
<code><a href="ReferencingByIdentifiers.html#computeHashCode()">compute­Hash­Code</a>, <a href="ReferencingByIdentifiers.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="ReferencingByIdentifiers.html#formatTo(org.apache.sis.io.wkt.Formatter)">format­To</a>, <a href="ReferencingByIdentifiers.html#getLocationTypes()">get­Location­Types</a>, <a href="ReferencingByIdentifiers.html#getOverallOwner()">get­Overall­Owner</a>, <a href="ReferencingByIdentifiers.html#getTheme()">get­Theme</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.AbstractReferenceSystem">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="../AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></h3>
<code><a href="../AbstractReferenceSystem.html#getDomainOfValidity()">get­Domain­Of­Validity</a>, <a href="../AbstractReferenceSystem.html#getInterface()">get­Interface</a>, <a href="../AbstractReferenceSystem.html#getScope()">get­Scope</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.AbstractIdentifiedObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="../AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3>
<code><a href="../AbstractIdentifiedObject.html#castOrCopy(org.opengis.referencing.IdentifiedObject)">cast­Or­Copy</a>, <a href="../AbstractIdentifiedObject.html#equals(java.lang.Object)">equals</a>, <a href="../AbstractIdentifiedObject.html#getAlias()">get­Alias</a>, <a href="../AbstractIdentifiedObject.html#getDescription()">get­Description</a>, <a href="../AbstractIdentifiedObject.html#getIdentifiers()">get­Identifiers</a>, <a href="../AbstractIdentifiedObject.html#getName()">get­Name</a>, <a href="../AbstractIdentifiedObject.html#getRemarks()">get­Remarks</a>, <a href="../AbstractIdentifiedObject.html#hashCode()">hash­Code</a>, <a href="../AbstractIdentifiedObject.html#isDeprecated()">is­Deprecated</a>, <a href="../AbstractIdentifiedObject.html#isHeuristicMatchForName(java.lang.String)">is­Heuristic­Match­For­Name</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.FormattableObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<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()">to­String</a>, <a href="../../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">to­String</a>, <a href="../../io/wkt/FormattableObject.html#toWKT()">to­WKT</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#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.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/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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.IdentifiedObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;<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">IdentifiedObject</a></h3>
<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getAlias()" title="class or interface in org.opengis.referencing" class="externalLink">get­Alias</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getIdentifiers()" title="class or interface in org.opengis.referencing" class="externalLink">get­Identifiers</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getName()" title="class or interface in org.opengis.referencing" class="externalLink">get­Name</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getRemarks()" title="class or interface in org.opengis.referencing" class="externalLink">get­Remarks</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#toWKT()" title="class or interface in org.opengis.referencing" class="externalLink">to­WKT</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MilitaryGridReferenceSystem</h4>
<pre>public&nbsp;MilitaryGridReferenceSystem()</pre>
<div class="block">Creates a new Military Grid Reference System (MGRS) using the default datum.
The current Apache SIS version uses the <a href="../CommonCRS.html#WGS84">WGS84</a> datum,
but this choice may change in the future if there is a need to adapt to new MGRS specifications.</div>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Map,org.apache.sis.referencing.CommonCRS)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MilitaryGridReferenceSystem</h4>
<pre>public&nbsp;MilitaryGridReferenceSystem&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;?&gt;&nbsp;properties,
<a href="../CommonCRS.html" title="enum in org.apache.sis.referencing">CommonCRS</a>&nbsp;datum)</pre>
<div class="block">Creates a new Military Grid Reference System (MGRS) using the specified datum.
Only the datums enumerated in <a href="../CommonCRS.html" title="enum in org.apache.sis.referencing"><code>Common­CRS</code></a> are currently supported.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - the properties to be given to the reference system.</dd>
<dd><code>datum</code> - the datum to which to transform coordinates before formatting the MGRS references,
or <code>null</code> for inferring the datum from the CRS associated to each coordinate.</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="createCoder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createCoder</h4>
<pre class="methodSignature">public&nbsp;<a href="MilitaryGridReferenceSystem.Coder.html" title="class in org.apache.sis.referencing.gazetteer">MilitaryGridReferenceSystem.Coder</a>&nbsp;createCoder()</pre>
<div class="block">Returns a new object performing conversions between <code>Direct­Position</code> and MGRS references.
The returned object is <strong>not</strong> thread-safe; a new instance must be created for
each thread, or synchronization must be applied by the caller.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new object performing conversions between <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/DirectPosition.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink"><code>Direct­Position</code></a> and MGRS references.</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/MilitaryGridReferenceSystem.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>