doc/JavaDoc/ch/epfl/sdp/peakar/points/ComputePOIPoints.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Fri Jun 04 18:15:38 CEST 2021 -->
<title>ComputePOIPoints</title>
<meta name="date" content="2021-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ComputePOIPoints";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li>Prev Class</li>
<li><a href="../../../../../ch/epfl/sdp/peakar/points/CountryHighPoint.html" title="class in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/points/ComputePOIPoints.html" target="_top">Frames</a></li>
<li><a href="ComputePOIPoints.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ch.epfl.sdp.peakar.points</div>
<h2 title="Class ComputePOIPoints" class="title">Class ComputePOIPoints</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.Observable</li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.points.ComputePOIPoints</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.Observer</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ComputePOIPoints</span>
extends java.util.Observable
implements java.util.Observer</pre>
<div class="block">Requests the POIPoints around the user location and then downloads the topography map once the
POIPoints are available.
To use, simply call computePOIPointsInstance.POIPoints to get a List of POIPoints or
computePOIPointsInstance to get a map with the POIPoints as keys and a boolean indicating if the POIPoint
is visible or not. If no points are available or if they are not computed yet, they will be null
This class is a singleton class.
This class can be observed, it will notify observers when new POIPoints are computed</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../ch/epfl/sdp/peakar/points/UserPoint.html" title="class in ch.epfl.sdp.peakar.points">UserPoint</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#userPoint">userPoint</a></span></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getFilteredPOIs--">getFilteredPOIs</a></span>()</code>
<div class="block">Gets a filtered Map of all surrounding POIPoints</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getFilteredPOIsInSight--">getFilteredPOIsInSight</a></span>()</code>
<div class="block">Gets a Map of the POIPoints that are in the line of sight and filtered</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getFilteredPOIsOutOfSight--">getFilteredPOIsOutOfSight</a></span>()</code>
<div class="block">Gets a Map of the POIPoints that are out of the line of sight and filtered</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html" title="class in ch.epfl.sdp.peakar.points">ComputePOIPoints</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getInstance-android.content.Context-">getInstance</a></span>(android.content.Context mContext)</code>
<div class="block">Method to get the singleton instance of this class.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getPOIs--">getPOIs</a></span>()</code>
<div class="block">Gets a Map of all surrounding POIPoints</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getPOIsInSight--">getPOIsInSight</a></span>()</code>
<div class="block">Gets a Map of the POIPoints that are in the line of sight</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#getPOIsOutOfSight--">getPOIsOutOfSight</a></span>()</code>
<div class="block">Gets a Map of the POIPoints that are out of the line of sight</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#isLineOfSightAvailable--">isLineOfSightAvailable</a></span>()</code>
<div class="block">Checks if the line of sight is available or not</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html#update-java.util.Observable-java.lang.Object-">update</a></span>(java.util.Observable o,
java.lang.Object arg)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Observable">
<!-- -->
</a>
<h3>Methods inherited from class java.util.Observable</h3>
<code>addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="userPoint">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>userPoint</h4>
<pre>public static <a href="../../../../../ch/epfl/sdp/peakar/points/UserPoint.html" title="class in ch.epfl.sdp.peakar.points">UserPoint</a> userPoint</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance-android.content.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static <a href="../../../../../ch/epfl/sdp/peakar/points/ComputePOIPoints.html" title="class in ch.epfl.sdp.peakar.points">ComputePOIPoints</a> getInstance(android.content.Context mContext)</pre>
<div class="block">Method to get the singleton instance of this class. If the class was already
initialized the parameter will be ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mContext</code> - context of the application.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>single instance of the user point.</dd>
</dl>
</li>
</ul>
<a name="isLineOfSightAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLineOfSightAvailable</h4>
<pre>public java.lang.Boolean isLineOfSightAvailable()</pre>
<div class="block">Checks if the line of sight is available or not</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the line of sight is available, false otherwise</dd>
</dl>
</li>
</ul>
<a name="getPOIs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPOIs</h4>
<pre>public java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean> getPOIs()</pre>
<div class="block">Gets a Map of all surrounding POIPoints</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map<POIPoint, Boolean> containing POIPoints.</dd>
</dl>
</li>
</ul>
<a name="getFilteredPOIs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilteredPOIs</h4>
<pre>public java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean> getFilteredPOIs()</pre>
<div class="block">Gets a filtered Map of all surrounding POIPoints</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map<POIPoint, Boolean> containing the filtered POIPoints.</dd>
</dl>
</li>
</ul>
<a name="getPOIsInSight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPOIsInSight</h4>
<pre>public java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean> getPOIsInSight()</pre>
<div class="block">Gets a Map of the POIPoints that are in the line of sight</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map<POIPoint, Boolean> containing only the POIPoints in the lineOfSight.</dd>
</dl>
</li>
</ul>
<a name="getFilteredPOIsInSight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilteredPOIsInSight</h4>
<pre>public java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean> getFilteredPOIsInSight()</pre>
<div class="block">Gets a Map of the POIPoints that are in the line of sight and filtered</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map<POIPoint, Boolean> containing the filtered POIPoints in the lineOfSight.</dd>
</dl>
</li>
</ul>
<a name="getPOIsOutOfSight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPOIsOutOfSight</h4>
<pre>public java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean> getPOIsOutOfSight()</pre>
<div class="block">Gets a Map of the POIPoints that are out of the line of sight</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map<POIPoint, Boolean> containing only the POIPoints out of the lineOfSight.</dd>
</dl>
</li>
</ul>
<a name="getFilteredPOIsOutOfSight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilteredPOIsOutOfSight</h4>
<pre>public java.util.Map<<a href="../../../../../ch/epfl/sdp/peakar/points/POIPoint.html" title="class in ch.epfl.sdp.peakar.points">POIPoint</a>,java.lang.Boolean> getFilteredPOIsOutOfSight()</pre>
<div class="block">Gets a Map of the POIPoints that are out of the line of sight and filtered</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map<POIPoint, Boolean> containing the filtered POIPoints out of the lineOfSight.</dd>
</dl>
</li>
</ul>
<a name="update-java.util.Observable-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>update</h4>
<pre>public void update(java.util.Observable o,
java.lang.Object arg)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>update</code> in interface <code>java.util.Observer</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li>Prev Class</li>
<li><a href="../../../../../ch/epfl/sdp/peakar/points/CountryHighPoint.html" title="class in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/points/ComputePOIPoints.html" target="_top">Frames</a></li>
<li><a href="ComputePOIPoints.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All 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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>