|
1 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 | | -<html xmlns="http://www.w3.org/1999/xhtml"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
3 | 3 | <head> |
4 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 | | -<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
6 | | -<meta name="generator" content="Doxygen 1.9.1"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 6 | +<meta name="generator" content="Doxygen 1.9.8"/> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
8 | 8 | <title>Viewshed: /home/runner/work/cpp-viewshed-library/cpp-viewshed-library/include/viewshed/abstractviewshedalgorithm.h Source File</title> |
9 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
19 | 19 | <div id="titlearea"> |
20 | 20 | <table cellspacing="0" cellpadding="0"> |
21 | 21 | <tbody> |
22 | | - <tr style="height: 56px;"> |
23 | | - <td id="projectalign" style="padding-left: 0.5em;"> |
| 22 | + <tr id="projectrow"> |
| 23 | + <td id="projectalign"> |
24 | 24 | <div id="projectname">Viewshed |
25 | 25 | </div> |
26 | 26 | <div id="projectbrief">A C++ library for calculation of viewshed, inverse viewshed and visibility indices for both of those analyses.</div> |
|
30 | 30 | </table> |
31 | 31 | </div> |
32 | 32 | <!-- end header part --> |
33 | | -<!-- Generated by Doxygen 1.9.1 --> |
| 33 | +<!-- Generated by Doxygen 1.9.8 --> |
34 | 34 | <script type="text/javascript"> |
35 | | -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
36 | | -var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| 35 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 36 | +var searchBox = new SearchBox("searchBox", "search/",'.html'); |
37 | 37 | /* @license-end */ |
38 | 38 | </script> |
39 | 39 | <script type="text/javascript" src="menudata.js"></script> |
40 | 40 | <script type="text/javascript" src="menu.js"></script> |
41 | 41 | <script type="text/javascript"> |
42 | | -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 42 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
43 | 43 | $(function() { |
44 | 44 | initMenu('',true,false,'search.php','Search'); |
45 | 45 | $(document).ready(function() { init_search(); }); |
46 | 46 | }); |
47 | | -/* @license-end */</script> |
| 47 | +/* @license-end */ |
| 48 | +</script> |
48 | 49 | <div id="main-nav"></div> |
| 50 | +<script type="text/javascript"> |
| 51 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 52 | +$(document).ready(function() { init_codefold(0); }); |
| 53 | +/* @license-end */ |
| 54 | +</script> |
49 | 55 | <!-- window showing the filter options --> |
50 | 56 | <div id="MSearchSelectWindow" |
51 | 57 | onmouseover="return searchBox.OnSearchSelectShow()" |
|
55 | 61 |
|
56 | 62 | <!-- iframe showing the search results (closed by default) --> |
57 | 63 | <div id="MSearchResultsWindow"> |
58 | | -<iframe src="javascript:void(0)" frameborder="0" |
59 | | - name="MSearchResults" id="MSearchResults"> |
60 | | -</iframe> |
| 64 | +<div id="MSearchResults"> |
| 65 | +<div class="SRPage"> |
| 66 | +<div id="SRIndex"> |
| 67 | +<div id="SRResults"></div> |
| 68 | +<div class="SRStatus" id="Loading">Loading...</div> |
| 69 | +<div class="SRStatus" id="Searching">Searching...</div> |
| 70 | +<div class="SRStatus" id="NoMatches">No Matches</div> |
| 71 | +</div> |
| 72 | +</div> |
| 73 | +</div> |
61 | 74 | </div> |
62 | 75 |
|
63 | 76 | <div id="nav-path" class="navpath"> |
|
66 | 79 | </div> |
67 | 80 | </div><!-- top --> |
68 | 81 | <div class="header"> |
69 | | - <div class="headertitle"> |
70 | | -<div class="title">abstractviewshedalgorithm.h</div> </div> |
| 82 | + <div class="headertitle"><div class="title">abstractviewshedalgorithm.h</div></div> |
71 | 83 | </div><!--header--> |
72 | 84 | <div class="contents"> |
73 | | -<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div> |
74 | | -<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  </div> |
75 | | -<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <limits></span></div> |
76 | | -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <string></span></div> |
77 | | -<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div> |
78 | | -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "abstractlos.h"</span></div> |
79 | | -<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "losimportantvalues.h"</span></div> |
80 | | -<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "losnode.h"</span></div> |
81 | | -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "point.h"</span></div> |
82 | | -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div> |
83 | | -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span>viewshed</div> |
84 | | -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div> |
85 | | -<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html"> 17</a></span>  <span class="keyword">class </span><a class="code" href="classviewshed_1_1AbstractViewshedAlgorithm.html">AbstractViewshedAlgorithm</a></div> |
86 | | -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  {</div> |
87 | | -<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">public</span>:</div> |
88 | | -<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html#adc52a103fef38c4cda2fc33c0a1776f1"> 27</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classviewshed_1_1AbstractViewshedAlgorithm.html#adc52a103fef38c4cda2fc33c0a1776f1">result</a>( std::shared_ptr<LoSImportantValues> losValues, std::shared_ptr<AbstractLoS> los ) = 0;</div> |
89 | | -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
90 | | -<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a9dda4fd39972b623268a95faa8e86313"> 34</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a9dda4fd39972b623268a95faa8e86313">pointValue</a>() = 0;</div> |
91 | | -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
92 | | -<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a6163385804fddcd7c45614bfea6dc2cd"> 41</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string <a class="code" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a6163385804fddcd7c45614bfea6dc2cd">name</a>() = 0;</div> |
93 | | -<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  };</div> |
94 | | -<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> |
95 | | -<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> } <span class="comment">// namespace viewshed</span></div> |
96 | | -<div class="ttc" id="aclassviewshed_1_1AbstractViewshedAlgorithm_html"><div class="ttname"><a href="classviewshed_1_1AbstractViewshedAlgorithm.html">viewshed::AbstractViewshedAlgorithm</a></div><div class="ttdoc">Base class for all Viewshed Algorithms.</div><div class="ttdef"><b>Definition:</b> abstractviewshedalgorithm.h:18</div></div> |
| 85 | +<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div> |
| 86 | +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include "viewshed_export.h"</span></div> |
| 87 | +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> |
| 88 | +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <limits></span></div> |
| 89 | +<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <string></span></div> |
| 90 | +<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div> |
| 91 | +<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "abstractlos.h"</span></div> |
| 92 | +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "losimportantvalues.h"</span></div> |
| 93 | +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "losnode.h"</span></div> |
| 94 | +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "point.h"</span></div> |
| 95 | +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div> |
| 96 | +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span>viewshed</div> |
| 97 | +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div> |
| 98 | +<div class="foldopen" id="foldopen00018" data-start="{" data-end="};"> |
| 99 | +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html"> 18</a></span> <span class="keyword">class </span>DLL_API <a class="code hl_class" href="classviewshed_1_1AbstractViewshedAlgorithm.html">AbstractViewshedAlgorithm</a></div> |
| 100 | +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div> |
| 101 | +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div> |
| 102 | +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html#adc52a103fef38c4cda2fc33c0a1776f1"> 28</a></span> <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classviewshed_1_1AbstractViewshedAlgorithm.html#adc52a103fef38c4cda2fc33c0a1776f1">result</a>( std::shared_ptr<LoSImportantValues> losValues, std::shared_ptr<AbstractLoS> los ) = 0;</div> |
| 103 | +<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| 104 | +<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a9dda4fd39972b623268a95faa8e86313"> 35</a></span> <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a9dda4fd39972b623268a95faa8e86313">pointValue</a>() = 0;</div> |
| 105 | +<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| 106 | +<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a6163385804fddcd7c45614bfea6dc2cd"> 42</a></span> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string <a class="code hl_function" href="classviewshed_1_1AbstractViewshedAlgorithm.html#a6163385804fddcd7c45614bfea6dc2cd">name</a>() = 0;</div> |
| 107 | +<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> };</div> |
| 108 | +</div> |
| 109 | +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> |
| 110 | +<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>} <span class="comment">// namespace viewshed</span></div> |
| 111 | +<div class="ttc" id="aclassviewshed_1_1AbstractViewshedAlgorithm_html"><div class="ttname"><a href="classviewshed_1_1AbstractViewshedAlgorithm.html">viewshed::AbstractViewshedAlgorithm</a></div><div class="ttdoc">Base class for all Viewshed Algorithms.</div><div class="ttdef"><b>Definition</b> abstractviewshedalgorithm.h:19</div></div> |
97 | 112 | <div class="ttc" id="aclassviewshed_1_1AbstractViewshedAlgorithm_html_a6163385804fddcd7c45614bfea6dc2cd"><div class="ttname"><a href="classviewshed_1_1AbstractViewshedAlgorithm.html#a6163385804fddcd7c45614bfea6dc2cd">viewshed::AbstractViewshedAlgorithm::name</a></div><div class="ttdeci">virtual const std::string name()=0</div><div class="ttdoc">Name of the algorithm.</div></div> |
98 | 113 | <div class="ttc" id="aclassviewshed_1_1AbstractViewshedAlgorithm_html_a9dda4fd39972b623268a95faa8e86313"><div class="ttname"><a href="classviewshed_1_1AbstractViewshedAlgorithm.html#a9dda4fd39972b623268a95faa8e86313">viewshed::AbstractViewshedAlgorithm::pointValue</a></div><div class="ttdeci">virtual double pointValue()=0</div><div class="ttdoc">Value at important point, either view point for viewshed or target point for inverse viewshed.</div></div> |
99 | 114 | <div class="ttc" id="aclassviewshed_1_1AbstractViewshedAlgorithm_html_adc52a103fef38c4cda2fc33c0a1776f1"><div class="ttname"><a href="classviewshed_1_1AbstractViewshedAlgorithm.html#adc52a103fef38c4cda2fc33c0a1776f1">viewshed::AbstractViewshedAlgorithm::result</a></div><div class="ttdeci">virtual double result(std::shared_ptr< LoSImportantValues > losValues, std::shared_ptr< AbstractLoS > los)=0</div><div class="ttdoc">Extract resulting value based on LoSImportantValues and specific los.</div></div> |
100 | 115 | </div><!-- fragment --></div><!-- contents --> |
101 | 116 | <!-- start footer part --> |
102 | 117 | <hr class="footer"/><address class="footer"><small> |
103 | | -Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| 118 | +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
104 | 119 | </small></address> |
105 | 120 | </body> |
106 | 121 | </html> |
0 commit comments