EVOLUTION-MANAGER
Edit File: AbstractNode_8h_source.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>GEOS: AbstractNode.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GEOS  <span id="projectnumber">3.8.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_c7abe0914a0ee2b00cd766c552eb2d19.html">include</a></li><li class="navelem"><a class="el" href="dir_165a26498f94b7fe2ccb32b9bb9b3ac5.html">geos</a></li><li class="navelem"><a class="el" href="dir_6aa9cc509533b63a9ccb9facff3cdf27.html">index</a></li><li class="navelem"><a class="el" href="dir_8366a4e5affccf0e5a2826b44083115e.html">strtree</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">AbstractNode.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**********************************************************************</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * GEOS - Geometry Engine Open Source</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * http://geos.osgeo.org</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Copyright (C) 2006 Refractions Research Inc.</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * This is free software; you can redistribute and/or modify it under</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * by the Free Software Foundation.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * See the COPYING file for more information.</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> **********************************************************************/</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef GEOS_INDEX_STRTREE_ABSTRACTNODE_H</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define GEOS_INDEX_STRTREE_ABSTRACTNODE_H</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <cassert></span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <cstddef></span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <geos/export.h></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <geos/index/strtree/Boundable.h></span> <span class="comment">// for inheritance</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <vector></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef _MSC_VER</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#pragma warning(push)</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="preprocessor">#pragma warning(disable: 4251) // warning C4251: needs to have dll-interface to be used by clients of class</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>geos {</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>index { <span class="comment">// geos::index</span></div> <div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespacegeos_1_1index_1_1strtree.html"> 32</a></span> <span class="keyword">namespace </span>strtree { <span class="comment">// geos::index::strtree</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html"> 44</a></span> <span class="keyword">class </span>GEOS_DLL <a class="code" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html">AbstractNode</a>: <span class="keyword">public</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a> {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  std::vector<Boundable*> childBoundables;</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> level;</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">/*</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * Constructs an AbstractNode at the given level in the tree</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @param level 0 if this node is a leaf, 1 if a parent of a leaf, and so on;</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * the root node will have the highest level</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html">AbstractNode</a>(<span class="keywordtype">int</span> newLevel, <span class="keywordtype">size_t</span> capacity = 10) : level(newLevel), bounds(<span class="keyword">nullptr</span>) {</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  childBoundables.reserve(capacity);</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  ~<a class="code" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html">AbstractNode</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// TODO: change signature to return by ref,</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// document ownership of the return</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">inline</span> std::vector<Boundable*>*</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  getChildBoundables()</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> &childBoundables;</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// TODO: change signature to return by ref,</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// document ownership of the return</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">inline</span> <span class="keyword">const</span> std::vector<Boundable*>*</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  getChildBoundables()<span class="keyword"> const</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> &childBoundables;</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a13d68705b6f03ed5d9858862ea5856ac"> 89</a></span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a13d68705b6f03ed5d9858862ea5856ac">getBounds</a>()<span class="keyword"> const override </span>{</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">if</span>(bounds == <span class="keyword">nullptr</span>) {</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  bounds = computeBounds();</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> bounds;</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a193da8fb4cbc4d55a647aa853a1cd64c"> 100</a></span>  <span class="keywordtype">int</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a193da8fb4cbc4d55a647aa853a1cd64c">getLevel</a>() {</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> level;</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a33779f2e2832d27f4bb988dff3b092f5"> 108</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a33779f2e2832d27f4bb988dff3b092f5">addChildBoundable</a>(<a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* childBoundable) {</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  assert(bounds == <span class="keyword">nullptr</span>);</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  childBoundables.push_back(childBoundable);</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">bool</span> isLeaf()<span class="keyword"> const override </span>{</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* computeBounds() <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">mutable</span> <span class="keywordtype">void</span>* bounds;</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> } <span class="comment">// namespace geos::index::strtree</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> } <span class="comment">// namespace geos::index</span></div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> } <span class="comment">// namespace geos</span></div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#ifdef _MSC_VER</span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor"></span><span class="preprocessor">#pragma warning(pop)</span></div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif // GEOS_INDEX_STRTREE_ABSTRACTNODE_H</span></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractNode_html_a13d68705b6f03ed5d9858862ea5856ac"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a13d68705b6f03ed5d9858862ea5856ac">geos::index::strtree::AbstractNode::getBounds</a></div><div class="ttdeci">const void * getBounds() const override</div><div class="ttdef"><b>Definition:</b> AbstractNode.h:89</div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractNode_html_a33779f2e2832d27f4bb988dff3b092f5"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a33779f2e2832d27f4bb988dff3b092f5">geos::index::strtree::AbstractNode::addChildBoundable</a></div><div class="ttdeci">void addChildBoundable(Boundable *childBoundable)</div><div class="ttdef"><b>Definition:</b> AbstractNode.h:108</div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractNode_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html">geos::index::strtree::AbstractNode</a></div><div class="ttdoc">A node of the STR tree. </div><div class="ttdef"><b>Definition:</b> AbstractNode.h:44</div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1Boundable_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1Boundable.html">geos::index::strtree::Boundable</a></div><div class="ttdoc">A spatial object in an AbstractSTRtree. </div><div class="ttdef"><b>Definition:</b> Boundable.h:25</div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractNode_html_a193da8fb4cbc4d55a647aa853a1cd64c"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html#a193da8fb4cbc4d55a647aa853a1cd64c">geos::index::strtree::AbstractNode::getLevel</a></div><div class="ttdeci">int getLevel()</div><div class="ttdef"><b>Definition:</b> AbstractNode.h:100</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>