454 lines
23 KiB
HTML
454 lines
23 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&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_1BaseGrid.html">BaseGrid</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="classKatabatic_1_1BaseGrid-members.html">List of all members</a> |
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">BaseGrid Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Abstract Base Class for Irregular <a class="el" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. ">Grid</a>.
|
|
<a href="classKatabatic_1_1BaseGrid.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BaseGrid:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classKatabatic_1_1BaseGrid__inherit__graph.png" border="0" usemap="#BaseGrid_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="BaseGrid_inherit__map" id="BaseGrid_inherit__map">
|
|
<area shape="rect" id="node2" href="classKatabatic_1_1Grid.html" title="Grid\< GCell \>" alt="" coords="5,80,120,107"/>
|
|
<area shape="rect" id="node4" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. " alt="" coords="144,80,267,107"/>
|
|
<area shape="rect" id="node3" href="classKatabatic_1_1GCellGrid.html" title="GCell Grid. " alt="" coords="21,155,104,181"/>
|
|
</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="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Graduations on a <a class="el" href="classKatabatic_1_1BaseGrid.html" title="Abstract Base Class for Irregular Grid. ">BaseGrid</a> <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html" title="Graduations on a BaseGrid Axis (H or V). ">Axis</a> (H or V). <a href="classKatabatic_1_1BaseGrid_1_1Axis.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a3a80b6032f86a56bec74609034b3246f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a3a80b6032f86a56bec74609034b3246f">destroy</a> ()</td></tr>
|
|
<tr class="separator:a3a80b6032f86a56bec74609034b3246f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b6cf5a28d88d7ad3e6ddeac28a35a0b"><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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a4b6cf5a28d88d7ad3e6ddeac28a35a0b">getBoundingBox</a> () const</td></tr>
|
|
<tr class="separator:a4b6cf5a28d88d7ad3e6ddeac28a35a0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaf0dae788f4c997e6172f9c734e3a91"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">getColumns</a> () const</td></tr>
|
|
<tr class="separator:aeaf0dae788f4c997e6172f9c734e3a91"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bad6abc58473d953258a3230506291a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a4bad6abc58473d953258a3230506291a">getRows</a> () const</td></tr>
|
|
<tr class="separator:a4bad6abc58473d953258a3230506291a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47cf844f090417180d0bae098133565e"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a47cf844f090417180d0bae098133565e">getRawSize</a> () const</td></tr>
|
|
<tr class="separator:a47cf844f090417180d0bae098133565e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae84726d9984c1df9905fc97d9b34f28"><td class="memItemLeft" align="right" valign="top">unsigned int </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8108a276ab72226244d302fb1b59f3f1"><td class="memItemLeft" align="right" valign="top">unsigned int </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21a8582c0c89a61d1963262fa053bc1b"><td class="memItemLeft" align="right" valign="top">unsigned int </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e3eea49f6f58fb8d0b3fa73f5cf3fd7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#a1e3eea49f6f58fb8d0b3fa73f5cf3fd7">getXGrads</a> () const</td></tr>
|
|
<tr class="separator:a1e3eea49f6f58fb8d0b3fa73f5cf3fd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab11d8b83eaa19f5fe6fecc63a8bb203e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseGrid.html#ab11d8b83eaa19f5fe6fecc63a8bb203e">getYGrads</a> () const</td></tr>
|
|
<tr class="separator:ab11d8b83eaa19f5fe6fecc63a8bb203e"><td class="memSeparator" colspan="2"> </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:ac479157e8ac115074615167e8a4a2789"><td class="memItemLeft" align="right" valign="top"> </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> &)</td></tr>
|
|
<tr class="separator:ac479157e8ac115074615167e8a4a2789"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Abstract Base Class for Irregular <a class="el" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. ">Grid</a>. </p>
|
|
<p>An abstract class for a 2-D matrix of objects. The grid is irregular in the sense that the horizontal and vertical cut lines may not be evenly spaced.</p>
|
|
<p>The coordinates of cut lines in horizontal and vertical direction are stored <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html" title="Graduations on a BaseGrid Axis (H or V). ">BaseGrid::Axis</a> structure.</p>
|
|
<p>The <a class="el" href="classKatabatic_1_1BaseGrid.html" title="Abstract Base Class for Irregular Grid. ">BaseGrid</a> contains all the non-template methods of the <a class="el" href="classKatabatic_1_1Grid.html" title="Template Class for Regular Grid. ">Grid</a>, that is that do not depend of the matrix element type.</p>
|
|
<p>The internal storage implemented in derived classes is expected to store "row by row" (rows are put one after another in the vector). </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ac479157e8ac115074615167e8a4a2789"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac479157e8ac115074615167e8a4a2789">◆ </a></span>BaseGrid()</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_1BaseGrid.html">BaseGrid</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> & </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">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Construct a new <a class="el" href="classKatabatic_1_1BaseGrid.html" title="Abstract Base Class for Irregular Grid. ">BaseGrid</a> on area <code>bb</code>. Graduations, rows & columns are sets to zero. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3a80b6032f86a56bec74609034b3246f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a80b6032f86a56bec74609034b3246f">◆ </a></span>destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void destroy </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>The user-level destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b6cf5a28d88d7ad3e6ddeac28a35a0b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b6cf5a28d88d7ad3e6ddeac28a35a0b">◆ </a></span>getBoundingBox()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">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> & getBoundingBox </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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 bounding box. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeaf0dae788f4c997e6172f9c734e3a91"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeaf0dae788f4c997e6172f9c734e3a91">◆ </a></span>getColumns()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int getColumns </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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 numbers of columns in the grid. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCellGrid.html#a3715b38135ca24745f610bebd3407c10">GCellGrid::_postCreate()</a>, <a class="el" href="classKatabatic_1_1KatabaticEngine.html#a1b7d8ed09a198f7afd6e3ac911f6eb37">KatabaticEngine::createDetailedGrid()</a>, <a class="el" href="classKatabatic_1_1BaseGrid.html#a21a8582c0c89a61d1963262fa053bc1b">BaseGrid::getColumn()</a>, <a class="el" href="classKatabatic_1_1BaseGrid.html#aae84726d9984c1df9905fc97d9b34f28">BaseGrid::getIndex()</a>, <a class="el" href="classKatabatic_1_1BaseGrid.html#a47cf844f090417180d0bae098133565e">BaseGrid::getRawSize()</a>, and <a class="el" href="classKatabatic_1_1BaseGrid.html#a8108a276ab72226244d302fb1b59f3f1">BaseGrid::getRow()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bad6abc58473d953258a3230506291a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bad6abc58473d953258a3230506291a">◆ </a></span>getRows()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int getRows </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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 numbers of rows in the grid. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCellGrid.html#a3715b38135ca24745f610bebd3407c10">GCellGrid::_postCreate()</a>, <a class="el" href="classKatabatic_1_1KatabaticEngine.html#a1b7d8ed09a198f7afd6e3ac911f6eb37">KatabaticEngine::createDetailedGrid()</a>, and <a class="el" href="classKatabatic_1_1BaseGrid.html#a47cf844f090417180d0bae098133565e">BaseGrid::getRawSize()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47cf844f090417180d0bae098133565e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47cf844f090417180d0bae098133565e">◆ </a></span>getRawSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int getRawSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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 total number of elements in the grid (i.e. <img class="formulaInl" alt="$ rows \times columns $" src="form_6.png"/>) </p>
|
|
|
|
<p class="reference">References <a class="el" href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">BaseGrid::getColumns()</a>, and <a class="el" href="classKatabatic_1_1BaseGrid.html#a4bad6abc58473d953258a3230506291a">BaseGrid::getRows()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae84726d9984c1df9905fc97d9b34f28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae84726d9984c1df9905fc97d9b34f28">◆ </a></span>getIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int getIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>c</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>r</em> </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>An helper function that compute the linear index in the element vector from a <code></code>(c,r) coordinate pair: </p><p class="formulaDsp">
|
|
<img class="formulaDsp" alt="\[ index = c + r \times columns \]" src="form_7.png"/>
|
|
</p>
|
|
|
|
<p class="reference">References <a class="el" href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">BaseGrid::getColumns()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1Grid.html#a4288eb8b1357d9800341b82df6b23944">Grid< GCell >::getGCellDown()</a>, <a class="el" href="classKatabatic_1_1Grid.html#ae5041816e75468b69bb0bbf24a4e8eca">Grid< GCell >::getGCellLeft()</a>, <a class="el" href="classKatabatic_1_1Grid.html#a0e9bba0feb437dca932d59703298358e">Grid< GCell >::getGCellRight()</a>, and <a class="el" href="classKatabatic_1_1Grid.html#a3a22f2bce9124765eb937b78c90059a0">Grid< GCell >::getGCellUp()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8108a276ab72226244d302fb1b59f3f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8108a276ab72226244d302fb1b59f3f1">◆ </a></span>getRow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int getRow </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>i</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>An helper function that compute the row number from the linear index in the vector: </p><p class="formulaDsp">
|
|
<img class="formulaDsp" alt="\[ row = index / columns \]" src="form_8.png"/>
|
|
</p>
|
|
|
|
<p class="reference">References <a class="el" href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">BaseGrid::getColumns()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCell.html#ad26f8bcf642c2620ac525cc04c8376c0">GCell::getRow()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21a8582c0c89a61d1963262fa053bc1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21a8582c0c89a61d1963262fa053bc1b">◆ </a></span>getColumn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int getColumn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>i</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>An helper function that compute the column number from the linear index in the vector: </p><p class="formulaDsp">
|
|
<img class="formulaDsp" alt="\[ column = index \div columns \]" src="form_9.png"/>
|
|
</p>
|
|
|
|
<p class="reference">References <a class="el" href="classKatabatic_1_1BaseGrid.html#aeaf0dae788f4c997e6172f9c734e3a91">BaseGrid::getColumns()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classKatabatic_1_1GCell.html#ac5b1a776c3eafa7f68d31292615011fa">GCell::getColumn()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1e3eea49f6f58fb8d0b3fa73f5cf3fd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1e3eea49f6f58fb8d0b3fa73f5cf3fd7">◆ </a></span>getXGrads()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a> & getXGrads </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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 graduations on the X axis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab11d8b83eaa19f5fe6fecc63a8bb203e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab11d8b83eaa19f5fe6fecc63a8bb203e">◆ </a></span>getYGrads()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classKatabatic_1_1BaseGrid_1_1Axis.html">Axis</a> & getYGrads </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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 graduations on the Y axis. </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.cpp</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 Thu Nov 12 2020</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 © 2008-2020 Sorbonne Universite. All rights reserved</small></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|