coriolis/katabatic/doc/html/classKatabatic_1_1Grid.html

496 lines
30 KiB
HTML

<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0//EN'>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Katabatic Documentation</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="SoC.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<h1 id="pagetop" class="header">Katabatic - Routing Toolbox</h1>
<!--
<center class="header">
<table class="header">
<tr>
<td><a href="customSummary.html">Summary</a></td>
<td><a href="namespaces.html">Namespaces</a></td>
<td><a href="customHierarchy.html">Class Hierarchy</a></td>
<td><a href="annotated.html">Classes</a></td>
<td><a href="functions.html">Member Index</a></td>
</tr>
</table>
</center>
-->
<br>
<body onload="javascript:toggleLevel(1)">
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKatabatic.html">Katabatic</a></li><li class="navelem"><a class="el" href="classKatabatic_1_1Grid.html">Grid</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classKatabatic_1_1Grid-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Grid&lt; GCellT &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Template Class for Regular <a class="el" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. ">Grid</a>.
<a href="classKatabatic_1_1Grid.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Grid&lt; GCellT &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classKatabatic_1_1Grid__inherit__graph.png" border="0" usemap="#Grid_3_01GCellT_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="Grid_3_01GCellT_01_4_inherit__map" id="Grid_3_01GCellT_01_4_inherit__map">
<area shape="rect" id="node2" href="classKatabatic_1_1BaseGrid.html" title="Abstract Base Class for Irregular Grid. " alt="" coords="22,5,97,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a98650c11b4aa0c6107c4d890dff61587"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a98650c11b4aa0c6107c4d890dff61587">getGCell</a> (unsigned int index) const</td></tr>
<tr class="separator:a98650c11b4aa0c6107c4d890dff61587"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ee3cd2fb8c66458b0d00e39826921da"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a0ee3cd2fb8c66458b0d00e39826921da">getGCell</a> (const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Point.html">Point</a> p) const</td></tr>
<tr class="separator:a0ee3cd2fb8c66458b0d00e39826921da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1beb5c490b2e651eab49178297b6cda2"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a1beb5c490b2e651eab49178297b6cda2">getGCell</a> (const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Point.html">Point</a> p1, const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Point.html">Point</a> p2) const</td></tr>
<tr class="separator:a1beb5c490b2e651eab49178297b6cda2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5041816e75468b69bb0bbf24a4e8eca"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#ae5041816e75468b69bb0bbf24a4e8eca">getGCellLeft</a> (const GCellT *gcell) const</td></tr>
<tr class="separator:ae5041816e75468b69bb0bbf24a4e8eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e9bba0feb437dca932d59703298358e"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a0e9bba0feb437dca932d59703298358e">getGCellRight</a> (const GCellT *gcell) const</td></tr>
<tr class="separator:a0e9bba0feb437dca932d59703298358e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a22f2bce9124765eb937b78c90059a0"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a3a22f2bce9124765eb937b78c90059a0">getGCellUp</a> (const GCellT *gcell) const</td></tr>
<tr class="separator:a3a22f2bce9124765eb937b78c90059a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4288eb8b1357d9800341b82df6b23944"><td class="memItemLeft" align="right" valign="top">GCellT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a4288eb8b1357d9800341b82df6b23944">getGCellDown</a> (const GCellT *gcell) const</td></tr>
<tr class="separator:a4288eb8b1357d9800341b82df6b23944"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24b4ab5b46b56ee744cf4c368a114d95"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1GenericCollection.html">GenericCollection</a>&lt; GCellT * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a24b4ab5b46b56ee744cf4c368a114d95">getGCells</a> ()</td></tr>
<tr class="separator:a24b4ab5b46b56ee744cf4c368a114d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8d0393323104d48c089a8429b254689"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1GenericCollection.html">GenericCollection</a>&lt; GCellT * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#aa8d0393323104d48c089a8429b254689">getGCellsColumn</a> (unsigned int column, unsigned int rowStart, unsigned int rowStop)</td></tr>
<tr class="separator:aa8d0393323104d48c089a8429b254689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35e2075302cdb696945f05c5bcc817a0"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1GenericCollection.html">GenericCollection</a>&lt; GCellT * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a35e2075302cdb696945f05c5bcc817a0">getGCellsRow</a> (unsigned int row, unsigned int columnStart, unsigned int columnStop)</td></tr>
<tr class="separator:a35e2075302cdb696945f05c5bcc817a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classKatabatic_1_1BaseGrid"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classKatabatic_1_1BaseGrid')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classKatabatic_1_1BaseGrid.html">BaseGrid</a></td></tr>
<tr class="memitem:a3a80b6032f86a56bec74609034b3246f inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a3a80b6032f86a56bec74609034b3246f">destroy</a> ()</td></tr>
<tr class="separator:a3a80b6032f86a56bec74609034b3246f inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b6cf5a28d88d7ad3e6ddeac28a35a0b inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Box.html">Box</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a4b6cf5a28d88d7ad3e6ddeac28a35a0b">getBoundingBox</a> () const</td></tr>
<tr class="separator:a4b6cf5a28d88d7ad3e6ddeac28a35a0b inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf0dae788f4c997e6172f9c734e3a91 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">getColumns</a> () const</td></tr>
<tr class="separator:aeaf0dae788f4c997e6172f9c734e3a91 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bad6abc58473d953258a3230506291a inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a4bad6abc58473d953258a3230506291a">getRows</a> () const</td></tr>
<tr class="separator:a4bad6abc58473d953258a3230506291a inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47cf844f090417180d0bae098133565e inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a47cf844f090417180d0bae098133565e">getRawSize</a> () const</td></tr>
<tr class="separator:a47cf844f090417180d0bae098133565e inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae84726d9984c1df9905fc97d9b34f28 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#aae84726d9984c1df9905fc97d9b34f28">getIndex</a> (unsigned int c, unsigned int r) const</td></tr>
<tr class="separator:aae84726d9984c1df9905fc97d9b34f28 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8108a276ab72226244d302fb1b59f3f1 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a8108a276ab72226244d302fb1b59f3f1">getRow</a> (unsigned int) const</td></tr>
<tr class="separator:a8108a276ab72226244d302fb1b59f3f1 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21a8582c0c89a61d1963262fa053bc1b inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a21a8582c0c89a61d1963262fa053bc1b">getColumn</a> (unsigned int) const</td></tr>
<tr class="separator:a21a8582c0c89a61d1963262fa053bc1b inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e3eea49f6f58fb8d0b3fa73f5cf3fd7 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a1e3eea49f6f58fb8d0b3fa73f5cf3fd7">getXGrads</a> () const</td></tr>
<tr class="separator:a1e3eea49f6f58fb8d0b3fa73f5cf3fd7 inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab11d8b83eaa19f5fe6fecc63a8bb203e inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#ab11d8b83eaa19f5fe6fecc63a8bb203e">getYGrads</a> () const</td></tr>
<tr class="separator:ab11d8b83eaa19f5fe6fecc63a8bb203e inherit pub_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a1b772cc784f7110caca47acb76dcec62"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Grid.html#a1b772cc784f7110caca47acb76dcec62">Grid</a> (const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Box.html">Box</a> &amp;)</td></tr>
<tr class="separator:a1b772cc784f7110caca47acb76dcec62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classKatabatic_1_1BaseGrid"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classKatabatic_1_1BaseGrid')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classKatabatic_1_1BaseGrid.html">BaseGrid</a></td></tr>
<tr class="memitem:ac479157e8ac115074615167e8a4a2789 inherit pro_methods_classKatabatic_1_1BaseGrid"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#ac479157e8ac115074615167e8a4a2789">BaseGrid</a> (const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Box.html">Box</a> &amp;)</td></tr>
<tr class="separator:ac479157e8ac115074615167e8a4a2789 inherit pro_methods_classKatabatic_1_1BaseGrid"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename GCellT&gt;<br />
class Katabatic::Grid&lt; GCellT &gt;</h3>
<p>Template Class for Regular <a class="el" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. ">Grid</a>. </p>
<p>Contains all general purpose methods depending on the <a class="el" href="classKatabatic_1_1GCell.html" title="Routing Global Cell. ">GCell</a> type and geometrical computations. The internal storage is still not implemented in this class. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1b772cc784f7110caca47acb76dcec62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b772cc784f7110caca47acb76dcec62">&#9670;&nbsp;</a></span>Grid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKatabatic_1_1Grid.html">Grid</a> </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Box.html">Box</a> &amp;&#160;</td>
<td class="paramname"><em>bb</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. ">Grid</a> constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a98650c11b4aa0c6107c4d890dff61587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98650c11b4aa0c6107c4d890dff61587">&#9670;&nbsp;</a></span>getGCell() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCell </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The grid object at linear index <code>index</code> in the vector. If <code>index</code> is out of bounds, return <code>NULL</code>. </p>
<p class="reference">Referenced by <a class="el" href="group__LoadGlobalRouting.html#ga60edeea78b56db072fc26a58a7afbcd4">GCellTopology::doRp_AccessPad()</a>, <a class="el" href="group__LoadGlobalRouting.html#gae9cae408ea16a3f7c77c3d75f0242f19">GCellTopology::doRp_AutoContacts()</a>, and <a class="el" href="group__LoadGlobalRouting.html#ga3973291866b39c10cea5ca17f7d174fb">anonymous_namespace{LoadGrByNet.cpp}::singleGCell()</a>.</p>
</div>
</div>
<a id="a0ee3cd2fb8c66458b0d00e39826921da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ee3cd2fb8c66458b0d00e39826921da">&#9670;&nbsp;</a></span>getGCell() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCell </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Point.html">Point</a>&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The grid object which is under position <code>p</code>. </p>
</div>
</div>
<a id="a1beb5c490b2e651eab49178297b6cda2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1beb5c490b2e651eab49178297b6cda2">&#9670;&nbsp;</a></span>getGCell() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCell </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Point.html">Point</a>&#160;</td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1Point.html">Point</a>&#160;</td>
<td class="paramname"><em>p2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The grid object which is under position <code>p1</code> and <code>p2</code>. Not very clear though. </p>
</div>
</div>
<a id="ae5041816e75468b69bb0bbf24a4e8eca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5041816e75468b69bb0bbf24a4e8eca">&#9670;&nbsp;</a></span>getGCellLeft()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCellLeft </td>
<td>(</td>
<td class="paramtype">const GCellT *&#160;</td>
<td class="paramname"><em>gcell</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The left neighbor of <code>gcell</code>, <code>NULL</code> if it is the leftmost one. </p>
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCell.html#a633722329744550b6da94c3b6fb97484">GCell::getLeft()</a>.</p>
</div>
</div>
<a id="a0e9bba0feb437dca932d59703298358e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e9bba0feb437dca932d59703298358e">&#9670;&nbsp;</a></span>getGCellRight()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCellRight </td>
<td>(</td>
<td class="paramtype">const GCellT *&#160;</td>
<td class="paramname"><em>gcell</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The rigth neighbor of <code>gcell</code>, <code>NULL</code> if it is the rightmost one. </p>
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCell.html#abdeb6b4a351f8b292894d3f0c24f105d">GCell::getRight()</a>.</p>
</div>
</div>
<a id="a3a22f2bce9124765eb937b78c90059a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a22f2bce9124765eb937b78c90059a0">&#9670;&nbsp;</a></span>getGCellUp()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCellUp </td>
<td>(</td>
<td class="paramtype">const GCellT *&#160;</td>
<td class="paramname"><em>gcell</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The upper neighbor of <code>gcell</code>, <code>NULL</code> if it is the uppermost one. </p>
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCell.html#a335506a314a2330b5a354906e798e60c">GCell::getUp()</a>.</p>
</div>
</div>
<a id="a4288eb8b1357d9800341b82df6b23944"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4288eb8b1357d9800341b82df6b23944">&#9670;&nbsp;</a></span>getGCellDown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CGellT * getGCellDown </td>
<td>(</td>
<td class="paramtype">const GCellT *&#160;</td>
<td class="paramname"><em>gcell</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> The down neighbor of <code>gcell</code>, <code>NULL</code> if it is the downmost one. </p>
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCell.html#ae448c9d6d028e967d7bd5a1bfdd05311">GCell::getDown()</a>.</p>
</div>
</div>
<a id="a24b4ab5b46b56ee744cf4c368a114d95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24b4ab5b46b56ee744cf4c368a114d95">&#9670;&nbsp;</a></span>getGCells()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1GenericCollection.html">GenericCollection</a>&lt; CGellT * &gt; getGCells </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> A GCellT Hurricane collection built upon the linear GCellT vector of the grid. </p>
</div>
</div>
<a id="aa8d0393323104d48c089a8429b254689"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8d0393323104d48c089a8429b254689">&#9670;&nbsp;</a></span>getGCellsColumn()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1GenericCollection.html">GenericCollection</a>&lt; CGellT * &gt; getGCellsColumn </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>rowStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>rowStop</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> A GCellT Hurricane collection that contains the part of <code>column</code> starting from <code>rowStart</code> to <code>rowStop</code> inclusive. </p>
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1KatabaticEngine.html#a1b7d8ed09a198f7afd6e3ac911f6eb37">KatabaticEngine::createDetailedGrid()</a>.</p>
</div>
</div>
<a id="a35e2075302cdb696945f05c5bcc817a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35e2075302cdb696945f05c5bcc817a0">&#9670;&nbsp;</a></span>getGCellsRow()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/dsk/l1/jpc/coriolis-2.x/src/coriolis/hurricane/doc/hurricane/html/hurricane.tag:../hurricane/" href="../hurricane/classHurricane_1_1GenericCollection.html">GenericCollection</a>&lt; CGellT * &gt; getGCellsRow </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>columnStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>columnStop</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Returns:</b> A GCellT Hurricane collection that contains the part of <code>row</code> starting from <code>columnStart</code> to <code>columnStop</code> inclusive. </p>
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1KatabaticEngine.html#a1b7d8ed09a198f7afd6e3ac911f6eb37">KatabaticEngine::createDetailedGrid()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Grid_8h_source.html">Grid.h</a></li>
<li>Grid.dox</li>
</ul>
</div><!-- contents -->
<br>
<hr>
<table class="footer1">
<tr>
<td class="LFooter"><small>Generated by doxygen 1.8.14 on Mon Oct 28 2019</small></td>
<td class="RFooter"><a href='#pagetop'><small>Return to top of page</small></a></td>
</tr>
</table>
<table class="footer2">
<tr>
<td class="LFooter">Katabatic - Routing Toolbox</td>
<td class="RFooter"><small>Copyright &#169; 2008-2016 UPMC. All rights reserved</small></td>
</tr>
</table>
</body>
</html>