BE-Graphes/Documentation/org/insa/graphs/model/io/BinaryGraphReader.html

549 lines
21 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (11.0.6) on Mon Mar 16 10:16:49 CET 2020 -->
<title>BinaryGraphReader</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-03-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.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="BinaryGraphReader";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
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/BinaryGraphReader.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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><a href="#field.detail">Field</a>&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.insa.graphs.model.io</a></div>
<h2 title="Class BinaryGraphReader" class="title">Class BinaryGraphReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="BinaryReader.html" title="class in org.insa.graphs.model.io">org.insa.graphs.model.io.BinaryReader</a></li>
<li>
<ul class="inheritance">
<li>org.insa.graphs.model.io.BinaryGraphReader</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code>, <code><a href="GraphReader.html" title="interface in org.insa.graphs.model.io">GraphReader</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">BinaryGraphReader</span>
extends <a href="BinaryReader.html" title="class in org.insa.graphs.model.io">BinaryReader</a>
implements <a href="GraphReader.html" title="interface in org.insa.graphs.model.io">GraphReader</a></pre>
<div class="block">Implementation of <a href="GraphReader.html" title="interface in org.insa.graphs.model.io"><code>GraphReader</code></a> to read graph in binary format.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MAGIC_NUMBER">MAGIC_NUMBER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MAP_ID_FIELD_LENGTH">MAP_ID_FIELD_LENGTH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="GraphReaderObserver.html" title="interface in org.insa.graphs.model.io">GraphReaderObserver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#observers">observers</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#VERSION">VERSION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.insa.graphs.model.io.BinaryReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.insa.graphs.model.io.<a href="BinaryReader.html" title="class in org.insa.graphs.model.io">BinaryReader</a></h3>
<code><a href="BinaryReader.html#dis">dis</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(java.io.DataInputStream)">BinaryGraphReader</a></span>&#8203;(java.io.DataInputStream&nbsp;dis)</code></th>
<td class="colLast">
<div class="block">Create a new BinaryGraphReader that read from the given input stream.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addObserver(org.insa.graphs.model.io.GraphReaderObserver)">addObserver</a></span>&#8203;(<a href="GraphReaderObserver.html" title="interface in org.insa.graphs.model.io">GraphReaderObserver</a>&nbsp;observer)</code></th>
<td class="colLast">
<div class="block">Add a new observer to this graph reader.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../Graph.html" title="class in org.insa.graphs.model">Graph</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#read()">read</a></span>()</code></th>
<td class="colLast">
<div class="block">Read a graph an returns it.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>private <a href="../RoadInformation.html" title="class in org.insa.graphs.model">RoadInformation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readRoadInformation()">readRoadInformation</a></span>()</code></th>
<td class="colLast">
<div class="block">Read the next road information from the stream.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected static <a href="../AccessRestrictions.html" title="class in org.insa.graphs.model">AccessRestrictions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toAccessInformation(long)">toAccessInformation</a></span>&#8203;(long&nbsp;access)</code></th>
<td class="colLast">
<div class="block">Parse the given long value into a new instance of AccessRestrictions.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected static <a href="../RoadInformation.RoadType.html" title="enum in org.insa.graphs.model">RoadInformation.RoadType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toRoadType(char)">toRoadType</a></span>&#8203;(char&nbsp;ch)</code></th>
<td class="colLast">
<div class="block">Convert a character to its corresponding road type.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.insa.graphs.model.io.BinaryReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.insa.graphs.model.io.<a href="BinaryReader.html" title="class in org.insa.graphs.model.io">BinaryReader</a></h3>
<code><a href="BinaryReader.html#checkByteOrThrow(int)">checkByteOrThrow</a>, <a href="BinaryReader.html#checkMagicNumberOrThrow(int)">checkMagicNumberOrThrow</a>, <a href="BinaryReader.html#checkVersionOrThrow(int)">checkVersionOrThrow</a>, <a href="BinaryReader.html#close()">close</a>, <a href="BinaryReader.html#getCurrentVersion()">getCurrentVersion</a>, <a href="BinaryReader.html#read24bits()">read24bits</a>, <a href="BinaryReader.html#readFixedLengthString(int,java.lang.String)">readFixedLengthString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.insa.graphs.model.io.GraphReader">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.insa.graphs.model.io.<a href="GraphReader.html" title="interface in org.insa.graphs.model.io">GraphReader</a></h3>
<code><a href="GraphReader.html#close()">close</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="VERSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERSION</h4>
<pre>private static final&nbsp;int VERSION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.insa.graphs.model.io.BinaryGraphReader.VERSION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MAGIC_NUMBER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAGIC_NUMBER</h4>
<pre>private static final&nbsp;int MAGIC_NUMBER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.insa.graphs.model.io.BinaryGraphReader.MAGIC_NUMBER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MAP_ID_FIELD_LENGTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAP_ID_FIELD_LENGTH</h4>
<pre>protected static final&nbsp;int MAP_ID_FIELD_LENGTH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.insa.graphs.model.io.BinaryGraphReader.MAP_ID_FIELD_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="observers">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>observers</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="GraphReaderObserver.html" title="interface in org.insa.graphs.model.io">GraphReaderObserver</a>&gt; observers</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= 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;(java.io.DataInputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BinaryGraphReader</h4>
<pre>public&nbsp;BinaryGraphReader&#8203;(java.io.DataInputStream&nbsp;dis)</pre>
<div class="block">Create a new BinaryGraphReader that read from the given input stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dis</code> - Input stream to read from.</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="toAccessInformation(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toAccessInformation</h4>
<pre class="methodSignature">protected static&nbsp;<a href="../AccessRestrictions.html" title="class in org.insa.graphs.model">AccessRestrictions</a>&nbsp;toAccessInformation&#8203;(long&nbsp;access)</pre>
<div class="block">Parse the given long value into a new instance of AccessRestrictions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>access</code> - The value to parse.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New instance of access restrictions parsed from the given value.</dd>
</dl>
</li>
</ul>
<a id="toRoadType(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toRoadType</h4>
<pre class="methodSignature">protected static&nbsp;<a href="../RoadInformation.RoadType.html" title="enum in org.insa.graphs.model">RoadInformation.RoadType</a>&nbsp;toRoadType&#8203;(char&nbsp;ch)</pre>
<div class="block">Convert a character to its corresponding road type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ch</code> - Character to convert.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Road type corresponding to the given character.</dd>
</dl>
</li>
</ul>
<a id="addObserver(org.insa.graphs.model.io.GraphReaderObserver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addObserver</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addObserver&#8203;(<a href="GraphReaderObserver.html" title="interface in org.insa.graphs.model.io">GraphReaderObserver</a>&nbsp;observer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="GraphReader.html#addObserver(org.insa.graphs.model.io.GraphReaderObserver)">GraphReader</a></code></span></div>
<div class="block">Add a new observer to this graph reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="GraphReader.html#addObserver(org.insa.graphs.model.io.GraphReaderObserver)">addObserver</a></code>&nbsp;in interface&nbsp;<code><a href="GraphReader.html" title="interface in org.insa.graphs.model.io">GraphReader</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>observer</code> - Observer to add.</dd>
</dl>
</li>
</ul>
<a id="read()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre class="methodSignature">public&nbsp;<a href="../Graph.html" title="class in org.insa.graphs.model">Graph</a>&nbsp;read()
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="GraphReader.html#read()">GraphReader</a></code></span></div>
<div class="block">Read a graph an returns it.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="GraphReader.html#read()">read</a></code>&nbsp;in interface&nbsp;<code><a href="GraphReader.html" title="interface in org.insa.graphs.model.io">GraphReader</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The graph read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an exception occurs while reading the graph.</dd>
</dl>
</li>
</ul>
<a id="readRoadInformation()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readRoadInformation</h4>
<pre class="methodSignature">private&nbsp;<a href="../RoadInformation.html" title="class in org.insa.graphs.model">RoadInformation</a>&nbsp;readRoadInformation()
throws java.io.IOException</pre>
<div class="block">Read the next road information from the stream.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The next RoadInformation in the stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs while reading from the stream.</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/BinaryGraphReader.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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><a href="#field.detail">Field</a>&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>
</footer>
</body>
</html>