<!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"/>
<title>GEOS: Key.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div 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 class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>Key.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * $Id: Key.h 2556 2009-06-06 22:22:28Z strk $</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * GEOS - Geometry Engine Open Source</span>
<a name="l00005"></a>00005 <span class="comment"> * http://geos.refractions.net</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2009 Sandro Santilli <strk@keybit.net></span>
<a name="l00008"></a>00008 <span class="comment"> * Copyright (C) 2006 Refractions Research Inc.</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2001-2002 Vivid Solutions Inc.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This is free software; you can redistribute and/or modify it under</span>
<a name="l00012"></a>00012 <span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span>
<a name="l00013"></a>00013 <span class="comment"> * by the Free Software Foundation. </span>
<a name="l00014"></a>00014 <span class="comment"> * See the COPYING file for more information.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> **********************************************************************</span>
<a name="l00017"></a>00017 <span class="comment"> *</span>
<a name="l00018"></a>00018 <span class="comment"> * Last port: index/quadtree/Key.java rev 1.8 (JTS-1.10)</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> **********************************************************************/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef GEOS_IDX_QUADTREE_KEY_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define GEOS_IDX_QUADTREE_KEY_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <geos/export.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <geos/geom/Coordinate.h></span> <span class="comment">// for composition</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <geos/geom/Envelope.h></span> <span class="comment">// for composition</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// Forward declarations</span>
<a name="l00030"></a>00030 <span class="comment">// ...</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>geos {
<a name="l00033"></a>00033 <span class="keyword">namespace </span>index { <span class="comment">// geos::index</span>
<a name="l00034"></a>00034 <span class="keyword">namespace </span>quadtree { <span class="comment">// geos::index::quadtree</span>
<a name="l00035"></a>00035
<a name="l00043"></a><a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html">00043</a> <span class="keyword">class </span>GEOS_DLL <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html" title="A Key is a unique identifier for a node in a quadtree.">Key</a> {
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="comment">// Doesn't touch the Envelope, might as well be const</span>
<a name="l00047"></a>00047 <span class="keyword">static</span> <span class="keywordtype">int</span> computeQuadLevel(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html" title="An Envelope defines a rectangulare region of the 2D coordinate plane.">geom::Envelope</a>& env);
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// Reference to argument won't be used after construction</span>
<a name="l00050"></a>00050 <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html" title="A Key is a unique identifier for a node in a quadtree.">Key</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html" title="An Envelope defines a rectangulare region of the 2D coordinate plane.">geom::Envelope</a>& itemEnv);
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">// used to be virtual, but I don't see subclasses...</span>
<a name="l00053"></a>00053 ~<a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html" title="A Key is a unique identifier for a node in a quadtree.">Key</a>();
<a name="l00054"></a>00054
<a name="l00056"></a>00056 <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">geom::Coordinate</a>& getPoint() <span class="keyword">const</span>;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keywordtype">int</span> getLevel() <span class="keyword">const</span>;
<a name="l00059"></a>00059
<a name="l00061"></a>00061 <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html" title="An Envelope defines a rectangulare region of the 2D coordinate plane.">geom::Envelope</a>& getEnvelope() <span class="keyword">const</span>;
<a name="l00062"></a>00062
<a name="l00064"></a>00064 <a class="code" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">geom::Coordinate</a>* getCentre() <span class="keyword">const</span>;
<a name="l00065"></a>00065
<a name="l00070"></a>00070 <span class="keywordtype">void</span> computeKey(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html" title="An Envelope defines a rectangulare region of the 2D coordinate plane.">geom::Envelope</a>& itemEnv);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">private</span>:
<a name="l00073"></a>00073 <span class="comment">// the fields which make up the key</span>
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Owned by this class</span>
<a name="l00076"></a>00076 <a class="code" href="classgeos_1_1geom_1_1Coordinate.html" title="Coordinate is the lightweight class used to store coordinates.">geom::Coordinate</a> pt;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">int</span> level;
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">// auxiliary data which is derived from the key for use in computation</span>
<a name="l00081"></a>00081 <a class="code" href="classgeos_1_1geom_1_1Envelope.html" title="An Envelope defines a rectangulare region of the 2D coordinate plane.">geom::Envelope</a> env;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">void</span> computeKey(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html" title="An Envelope defines a rectangulare region of the 2D coordinate plane.">geom::Envelope</a>& itemEnv);
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085
<a name="l00086"></a>00086 } <span class="comment">// namespace geos::index::quadtree</span>
<a name="l00087"></a>00087 } <span class="comment">// namespace geos::index</span>
<a name="l00088"></a>00088 } <span class="comment">// namespace geos</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="preprocessor">#endif // GEOS_IDX_QUADTREE_KEY_H</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
<a name="l00092"></a>00092 <span class="comment">/**********************************************************************</span>
<a name="l00093"></a>00093 <span class="comment"> * $Log$</span>
<a name="l00094"></a>00094 <span class="comment"> * Revision 1.1 2006/03/22 12:22:50 strk</span>
<a name="l00095"></a>00095 <span class="comment"> * indexQuadtree.h split</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> **********************************************************************/</span>
<a name="l00098"></a>00098
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
