1308 lines
71 KiB
HTML
1308 lines
71 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>Hurricane 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">Hurricane VLSI Database</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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#enumval-members">Enumerator</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DbU/Unit description</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Fixed point numbers management.
|
|
<a href="#details">More...</a></p>
|
|
<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="classHurricane_1_1DbU.html">Hurricane::DbU</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classHurricane_1_1DataBase.html" title="The whole DataBase (API). ">DataBase</a> Unit managment (<b>API</b>). <a href="classHurricane_1_1DbU.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="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga4fbfa3e8c89347af76c9628ea06c4146"><td class="memItemLeft" align="right" valign="top">typedef std::int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Hurricane::DbU::Unit</a></td></tr>
|
|
<tr class="separator:ga4fbfa3e8c89347af76c9628ea06c4146"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga6af6a5b8d113a661fea65b2bcb8b25c4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga6af6a5b8d113a661fea65b2bcb8b25c4">Hurricane::DbU::StringMode</a> { <br />
|
|
  <a class="el" href="group__DbUGroup.html#gga6af6a5b8d113a661fea65b2bcb8b25c4a1b91af5faf467afcb73dec10bc54f233">Hurricane::DbU::Db</a> = (1<<0),
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga6af6a5b8d113a661fea65b2bcb8b25c4ac6b6574b2ef79ee4e44c6c00fe757c7c">Hurricane::DbU::Grid</a> = (1<<1),
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga6af6a5b8d113a661fea65b2bcb8b25c4a16f8df0900c42b001f0a91475a1b93f8">Hurricane::DbU::Symbolic</a> = (1<<2)
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ga6af6a5b8d113a661fea65b2bcb8b25c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga50b5785bf4d75026c4c112caec3040a7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">Hurricane::DbU::UnitPower</a> { <br />
|
|
  <a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7a3cf34ad82faf73a9b48dcb3a621d0557">Hurricane::DbU::Pico</a> = 1,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7a03e5923be5810db830626f2ca26319d6">Hurricane::DbU::Nano</a>,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7aa0481a3398a6cbb0a68a523146f0a7fb">Hurricane::DbU::Micro</a>,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7aac2973886c68f16ee68a192154ea65be">Hurricane::DbU::Milli</a>,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7ac5c524bb7247124f3dce7d1dbdc7d2c6">Hurricane::DbU::Unity</a>,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7a7853e18601786b5c51a1bc9cfaf8bb74">Hurricane::DbU::Kilo</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ga50b5785bf4d75026c4c112caec3040a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1082168d6f9956ebba22ab8bbec21637"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">Hurricane::DbU::SnapMode</a> { <br />
|
|
  <a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a888eae532f84c3f19b024e1830ef8cb3">Hurricane::DbU::Inferior</a> = 1,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a8ce92cf7ff7627c46baf85612f9ad847">Hurricane::DbU::Superior</a> = 2,
|
|
<br />
|
|
  <a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Hurricane::DbU::Nearest</a> = 4
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ga1082168d6f9956ebba22ab8bbec21637"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaec69d65ec1651c2feea24c5931f4580b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gaec69d65ec1651c2feea24c5931f4580b">Hurricane::DbU::fromDb</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> value)</td></tr>
|
|
<tr class="separator:gaec69d65ec1651c2feea24c5931f4580b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga367e1d1b5ac1df076745550cba8a83c1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga367e1d1b5ac1df076745550cba8a83c1">Hurricane::DbU::fromGrid</a> (double value)</td></tr>
|
|
<tr class="separator:ga367e1d1b5ac1df076745550cba8a83c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4b570755b19ea9ff0f2f258a221bd935"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga4b570755b19ea9ff0f2f258a221bd935">Hurricane::DbU::fromLambda</a> (double value)</td></tr>
|
|
<tr class="separator:ga4b570755b19ea9ff0f2f258a221bd935"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga11d4dbd9134a19bda35cbacde1cb2769"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga11d4dbd9134a19bda35cbacde1cb2769">Hurricane::DbU::fromPhysical</a> (double value, <a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">UnitPower</a> p)</td></tr>
|
|
<tr class="separator:ga11d4dbd9134a19bda35cbacde1cb2769"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaec07c6e7ae2a2a6f54e2a16b32c8bf26"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gaec07c6e7ae2a2a6f54e2a16b32c8bf26">Hurricane::DbU::toDb</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u)</td></tr>
|
|
<tr class="separator:gaec07c6e7ae2a2a6f54e2a16b32c8bf26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga318d673386c9424e07c12efd598c730d"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga318d673386c9424e07c12efd598c730d">Hurricane::DbU::toGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u)</td></tr>
|
|
<tr class="separator:ga318d673386c9424e07c12efd598c730d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4923a9a443871282ad7d331be2a2a5d4"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga4923a9a443871282ad7d331be2a2a5d4">Hurricane::DbU::toLambda</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u)</td></tr>
|
|
<tr class="separator:ga4923a9a443871282ad7d331be2a2a5d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab901e9d5c12e878728178f113def6c45"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gab901e9d5c12e878728178f113def6c45">Hurricane::DbU::toPhysical</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u, <a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">UnitPower</a> p)</td></tr>
|
|
<tr class="separator:gab901e9d5c12e878728178f113def6c45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6169efbdd9b3d54a0bd8467c8f957fda"><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga6169efbdd9b3d54a0bd8467c8f957fda">Hurricane::DbU::getPrecision</a> ()</td></tr>
|
|
<tr class="separator:ga6169efbdd9b3d54a0bd8467c8f957fda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8756c9f0a32af5f601cd150e73b02c03"><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga8756c9f0a32af5f601cd150e73b02c03">Hurricane::DbU::getMaximalPrecision</a> ()</td></tr>
|
|
<tr class="separator:ga8756c9f0a32af5f601cd150e73b02c03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga120a60b09b344d01c583567a1e489d9e"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga120a60b09b344d01c583567a1e489d9e">Hurricane::DbU::getResolution</a> ()</td></tr>
|
|
<tr class="separator:ga120a60b09b344d01c583567a1e489d9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac93f9ba2a09105227e34bd05bcb1500c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gac93f9ba2a09105227e34bd05bcb1500c">Hurricane::DbU::setGridsPerLambda</a> (double gridsPerLambda, unsigned int flags=NoFlags)</td></tr>
|
|
<tr class="separator:gac93f9ba2a09105227e34bd05bcb1500c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9a0359adbfafc356326f5c6adf57ff04"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga9a0359adbfafc356326f5c6adf57ff04">Hurricane::DbU::getGridsPerLambda</a> ()</td></tr>
|
|
<tr class="separator:ga9a0359adbfafc356326f5c6adf57ff04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga89ab8f8326c54113336086663ecf1d25"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga89ab8f8326c54113336086663ecf1d25">Hurricane::DbU::setStringMode</a> (unsigned int mode, <a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">UnitPower</a> p=<a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7a03e5923be5810db830626f2ca26319d6">Nano</a>)</td></tr>
|
|
<tr class="separator:ga89ab8f8326c54113336086663ecf1d25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadc9c1a06b4296dbddcf711077113f4bd"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gadc9c1a06b4296dbddcf711077113f4bd">Hurricane::DbU::getValueString</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u, int mode=SmartTruncate)</td></tr>
|
|
<tr class="separator:gadc9c1a06b4296dbddcf711077113f4bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gace9a8644e7e80dcaed2a8a95deeb1622"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gace9a8644e7e80dcaed2a8a95deeb1622">Hurricane::DbU::setPrecision</a> (unsigned int precision, unsigned int flags=NoFlags)</td></tr>
|
|
<tr class="separator:gace9a8644e7e80dcaed2a8a95deeb1622"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga202cc3aa3364c2224647a29dde047fae"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga202cc3aa3364c2224647a29dde047fae">Hurricane::DbU::setRealSnapGridStep</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> step)</td></tr>
|
|
<tr class="separator:ga202cc3aa3364c2224647a29dde047fae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga09e46fcca6aaca94851adfa196e10170"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga09e46fcca6aaca94851adfa196e10170">Hurricane::DbU::getRealSnapGridStep</a> ()</td></tr>
|
|
<tr class="separator:ga09e46fcca6aaca94851adfa196e10170"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8746e486f153aa37ee469c1604eba5c0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga8746e486f153aa37ee469c1604eba5c0">Hurricane::DbU::getOnRealSnapGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u, <a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">SnapMode</a> mode=<a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Nearest</a>)</td></tr>
|
|
<tr class="separator:ga8746e486f153aa37ee469c1604eba5c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9ccd423c8f268ef54770f4663e6c9304"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga9ccd423c8f268ef54770f4663e6c9304">Hurricane::DbU::setSymbolicSnapGridStep</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> step)</td></tr>
|
|
<tr class="separator:ga9ccd423c8f268ef54770f4663e6c9304"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga687a9134729b107c42fb7f69596c4c3b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga687a9134729b107c42fb7f69596c4c3b">Hurricane::DbU::getSymbolicSnapGridStep</a> ()</td></tr>
|
|
<tr class="separator:ga687a9134729b107c42fb7f69596c4c3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad1b0c0f3680093cf5a63d901312c925d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gad1b0c0f3680093cf5a63d901312c925d">Hurricane::DbU::getOnSymbolicSnapGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u, <a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">SnapMode</a> mode=<a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Nearest</a>)</td></tr>
|
|
<tr class="separator:gad1b0c0f3680093cf5a63d901312c925d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga87323d9038656dceabffc37d45de408a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga87323d9038656dceabffc37d45de408a">Hurricane::DbU::getOnCustomGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u, <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> step, <a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">SnapMode</a> mode=<a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Nearest</a>)</td></tr>
|
|
<tr class="separator:ga87323d9038656dceabffc37d45de408a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9419025221579f4277475c65655be3dc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga9419025221579f4277475c65655be3dc">Hurricane::DbU::getOnPhysicalGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u, <a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">SnapMode</a> mode=<a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a8ce92cf7ff7627c46baf85612f9ad847">Superior</a>)</td></tr>
|
|
<tr class="separator:ga9419025221579f4277475c65655be3dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Obsoleteds</h2></td></tr>
|
|
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpf05125b8b6a468721054b36b1a1cfd62"></a> Due to their somewhat unclear naming convention, those functions have been renamed by the <em>to</em> / <em>from</em> variants. </p>
|
|
</td></tr>
|
|
<tr class="memitem:gacd77957381fb93fc4203bdca215e0b48"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gacd77957381fb93fc4203bdca215e0b48">Hurricane::DbU::db</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> value)</td></tr>
|
|
<tr class="separator:gacd77957381fb93fc4203bdca215e0b48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1d4bac6e3b68c8cd44b345de3b425753"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga1d4bac6e3b68c8cd44b345de3b425753">Hurricane::DbU::grid</a> (double value)</td></tr>
|
|
<tr class="separator:ga1d4bac6e3b68c8cd44b345de3b425753"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1ba98acc939ff1c370c18544a5e0dce"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gaa1ba98acc939ff1c370c18544a5e0dce">Hurricane::DbU::lambda</a> (double value)</td></tr>
|
|
<tr class="separator:gaa1ba98acc939ff1c370c18544a5e0dce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4233772b1b3e68f3ec723c7509ea87ff"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#ga4233772b1b3e68f3ec723c7509ea87ff">Hurricane::DbU::getDb</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u)</td></tr>
|
|
<tr class="separator:ga4233772b1b3e68f3ec723c7509ea87ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad4485d0d7b5fd7ae87b32f165155c0a2"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gad4485d0d7b5fd7ae87b32f165155c0a2">Hurricane::DbU::getGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u)</td></tr>
|
|
<tr class="separator:gad4485d0d7b5fd7ae87b32f165155c0a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadea6b9a6e84243f70f3a5e2725b2c6d8"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DbUGroup.html#gadea6b9a6e84243f70f3a5e2725b2c6d8">Hurricane::DbU::getLambda</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> u)</td></tr>
|
|
<tr class="separator:gadea6b9a6e84243f70f3a5e2725b2c6d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Fixed point numbers management. </p>
|
|
<h1><a class="anchor" id="secDbUIntro"></a>
|
|
Introduction</h1>
|
|
<p>The <a class="el" href="classHurricane_1_1DbU.html" title="DataBase Unit managment (API). ">DbU</a> class provides the <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> type for modelling geometric length, that is abscissas, ordinates, widths, offsets and a set of functions to convert <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> to and from external coordinates.</p>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>The <a class="el" href="classHurricane_1_1DbU.html" title="DataBase Unit managment (API). ">DbU</a> class contains only static methods, and is not meant to be instanciated. The working type is <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a>.</dd></dl>
|
|
<p>The <a class="el" href="classHurricane_1_1DbU.html" title="DataBase Unit managment (API). ">DbU</a> class manage three king of length : </p><ul>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a></b> : the working type. It is currently associated to a long integer and a precision/resolution. This way all numbers are bound to the same precision (unlike floating point numbers) preventing rounding errors. </li>
|
|
<li>
|
|
<b>Real</b> length : length, expressed in steps of founder grid. We have the straight relation ship : grid = unit * resolution </li>
|
|
<li>
|
|
<b>Symbolic</b> length : length, expressed in lambdas. A lambda is an even multiple of the founder grid step. lambda = grid / lambdaPerGrid </li>
|
|
</ul>
|
|
<h1><a class="anchor" id="secDbUPrecision"></a>
|
|
Precision</h1>
|
|
<p>It is possible to choose (once for all) the precision with which unit values are stored.</p>
|
|
<p>This precision represents the maximal number of decimal digits allowed (it applies globally to all units). Therefore for a precision of 3, the unit will represent a value of 0.001 and the founder grid value 23.54 will be represented by a unit equal to 23540.</p>
|
|
<p>Related functions : </p><ul>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga6169efbdd9b3d54a0bd8467c8f957fda">DbU::getPrecision()</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga8756c9f0a32af5f601cd150e73b02c03">DbU::getMaximalPrecision()</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#gace9a8644e7e80dcaed2a8a95deeb1622">DbU::setPrecision()</a></b> </li>
|
|
</ul>
|
|
<h1><a class="anchor" id="secDbUResolution"></a>
|
|
Resolution</h1>
|
|
<p>The resolution is associated to the precision. Indeed it represents the external value associated to the smallest unit, that is the value returned by getGrid(Unit::db(1)).</p>
|
|
<p>Related functions : <b><a class="el" href="group__DbUGroup.html#ga120a60b09b344d01c583567a1e489d9e">DbU::getResolution()</a></b></p>
|
|
<h1><a class="anchor" id="secDbUGridsPerLamba"></a>
|
|
Grids per Lambda ratio</h1>
|
|
<p>Set the ratio between grids and lambdas. This must be an even integer. Once sets, musn't be changed.</p>
|
|
<p>Related functions : </p><ul>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#gac93f9ba2a09105227e34bd05bcb1500c">DbU::setGridsPerLambda()</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga9a0359adbfafc356326f5c6adf57ff04">DbU::getGridsPerLambda()</a></b> </li>
|
|
</ul>
|
|
<h1><a class="anchor" id="secDbUGrid"></a>
|
|
Grid</h1>
|
|
<p>Thoses function are closely related to editors. They allow to restrict to positions on a grid. We support three kind of grid, real, symbolic and user defined.</p>
|
|
<ul>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga09e46fcca6aaca94851adfa196e10170">DbU::getRealSnapGridStep</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga8746e486f153aa37ee469c1604eba5c0">DbU::getOnRealSnapGrid</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga202cc3aa3364c2224647a29dde047fae">DbU::setRealSnapGridStep</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga687a9134729b107c42fb7f69596c4c3b">DbU::getSymbolicSnapGridStep</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#gad1b0c0f3680093cf5a63d901312c925d">DbU::getOnSymbolicSnapGrid</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga9ccd423c8f268ef54770f4663e6c9304">DbU::setSymbolicSnapGridStep</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga87323d9038656dceabffc37d45de408a">DbU::getOnCustomGrid</a></b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga9419025221579f4277475c65655be3dc">DbU::getOnPhysicalGrid</a></b> </li>
|
|
</ul>
|
|
<h1><a class="anchor" id="secDbUTranslators"></a>
|
|
Translators</h1>
|
|
<p>Translate a <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> into grid or lambda length : </p><ul>
|
|
<li>
|
|
<b>long <a class="el" href="group__DbUGroup.html#gaec07c6e7ae2a2a6f54e2a16b32c8bf26">DbU::toDb</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u)</b> </li>
|
|
<li>
|
|
<b>double <a class="el" href="group__DbUGroup.html#ga318d673386c9424e07c12efd598c730d">DbU::toGrid</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u)</b> </li>
|
|
<li>
|
|
<b>double <a class="el" href="group__DbUGroup.html#ga4923a9a443871282ad7d331be2a2a5d4">DbU::toLambda</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u)</b> </li>
|
|
<li>
|
|
<b>double <a class="el" href="group__DbUGroup.html#gab901e9d5c12e878728178f113def6c45">DbU::toPhysical</a> (<a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> u, UnitPower p)</b> </li>
|
|
</ul>
|
|
<p>Translate a lambda length into a <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> : </p><ul>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> <a class="el" href="group__DbUGroup.html#gaec69d65ec1651c2feea24c5931f4580b">DbU::fromDb</a> (long v)</b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> <a class="el" href="group__DbUGroup.html#ga367e1d1b5ac1df076745550cba8a83c1">DbU::fromGrid</a> (double v)</b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> <a class="el" href="group__DbUGroup.html#ga4b570755b19ea9ff0f2f258a221bd935">DbU::fromLambda</a> (double v)</b> </li>
|
|
<li>
|
|
<b><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> <a class="el" href="group__DbUGroup.html#ga11d4dbd9134a19bda35cbacde1cb2769">DbU::fromPhysical</a> (double v, UnitPower p)</b> </li>
|
|
</ul>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="ga4fbfa3e8c89347af76c9628ea06c4146"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4fbfa3e8c89347af76c9628ea06c4146">◆ </a></span>Unit</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long <a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Hurricane::DbU::Unit</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The working <a class="el" href="classHurricane_1_1DataBase.html" title="The whole DataBase (API). ">DataBase</a> type for storing dimensions. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga6af6a5b8d113a661fea65b2bcb8b25c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6af6a5b8d113a661fea65b2bcb8b25c4">◆ </a></span>StringMode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__DbUGroup.html#ga6af6a5b8d113a661fea65b2bcb8b25c4">Hurricane::DbU::StringMode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Select how units are to be printed by <a class="el" href="group__DbUGroup.html#gadc9c1a06b4296dbddcf711077113f4bd">getValueString()</a>. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6af6a5b8d113a661fea65b2bcb8b25c4a1b91af5faf467afcb73dec10bc54f233"></a>Db </td><td class="fielddoc"><p>Units are printed "as is", their true value as stored in the <a class="el" href="classHurricane_1_1DataBase.html" title="The whole DataBase (API). ">DataBase</a>. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6af6a5b8d113a661fea65b2bcb8b25c4ac6b6574b2ef79ee4e44c6c00fe757c7c"></a>Grid </td><td class="fielddoc"><p>Units are printed as founder grid steps. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6af6a5b8d113a661fea65b2bcb8b25c4a16f8df0900c42b001f0a91475a1b93f8"></a>Symbolic </td><td class="fielddoc"><p>Units are printed as symbolic (lambdas). </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga50b5785bf4d75026c4c112caec3040a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga50b5785bf4d75026c4c112caec3040a7">◆ </a></span>UnitPower</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">Hurricane::DbU::UnitPower</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This enumeration defines the power applicable to physical units. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga50b5785bf4d75026c4c112caec3040a7a3cf34ad82faf73a9b48dcb3a621d0557"></a>Pico </td><td class="fielddoc"><p>10e-12 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga50b5785bf4d75026c4c112caec3040a7a03e5923be5810db830626f2ca26319d6"></a>Nano </td><td class="fielddoc"><p>10e-9 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga50b5785bf4d75026c4c112caec3040a7aa0481a3398a6cbb0a68a523146f0a7fb"></a>Micro </td><td class="fielddoc"><p>10e-6 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga50b5785bf4d75026c4c112caec3040a7aac2973886c68f16ee68a192154ea65be"></a>Milli </td><td class="fielddoc"><p>10e-3 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga50b5785bf4d75026c4c112caec3040a7ac5c524bb7247124f3dce7d1dbdc7d2c6"></a>Unity </td><td class="fielddoc"><p>1 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga50b5785bf4d75026c4c112caec3040a7a7853e18601786b5c51a1bc9cfaf8bb74"></a>Kilo </td><td class="fielddoc"><p>10e+3 </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1082168d6f9956ebba22ab8bbec21637"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1082168d6f9956ebba22ab8bbec21637">◆ </a></span>SnapMode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">Hurricane::DbU::SnapMode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This enumeration defines the rounding applicable to the grid management functions. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1082168d6f9956ebba22ab8bbec21637a888eae532f84c3f19b024e1830ef8cb3"></a>Inferior </td><td class="fielddoc"><p>Round to the inferior grid point. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga1082168d6f9956ebba22ab8bbec21637a8ce92cf7ff7627c46baf85612f9ad847"></a>Superior </td><td class="fielddoc"><p>Round to the superior grid point. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5"></a>Nearest </td><td class="fielddoc"><p>Round nearest grid point, inferior or superior depending on the distance. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gaec69d65ec1651c2feea24c5931f4580b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaec69d65ec1651c2feea24c5931f4580b">◆ </a></span>fromDb()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::fromDb </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the value <code><value></code> according to the current precision. This function do nothing apart from a cast. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#gacd77957381fb93fc4203bdca215e0b48">Hurricane::DbU::db()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga367e1d1b5ac1df076745550cba8a83c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga367e1d1b5ac1df076745550cba8a83c1">◆ </a></span>fromGrid()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::fromGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the <em>grid</em> value <code><value></code> according to the current precision. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#ga4b570755b19ea9ff0f2f258a221bd935">Hurricane::DbU::fromLambda()</a>, <a class="el" href="group__DbUGroup.html#ga11d4dbd9134a19bda35cbacde1cb2769">Hurricane::DbU::fromPhysical()</a>, and <a class="el" href="group__DbUGroup.html#ga1d4bac6e3b68c8cd44b345de3b425753">Hurricane::DbU::grid()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4b570755b19ea9ff0f2f258a221bd935"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4b570755b19ea9ff0f2f258a221bd935">◆ </a></span>fromLambda()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::fromLambda </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the <em>symbolic</em> value <code><value></code> according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga367e1d1b5ac1df076745550cba8a83c1">Hurricane::DbU::fromGrid()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#gaa1ba98acc939ff1c370c18544a5e0dce">Hurricane::DbU::lambda()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga11d4dbd9134a19bda35cbacde1cb2769"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga11d4dbd9134a19bda35cbacde1cb2769">◆ </a></span>fromPhysical()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::fromPhysical </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">UnitPower</a> </td>
|
|
<td class="paramname"><em>p</em> </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 class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the <em>physical</em> value <code><value></code> with power <code>p</code>, according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga367e1d1b5ac1df076745550cba8a83c1">Hurricane::DbU::fromGrid()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaec07c6e7ae2a2a6f54e2a16b32c8bf26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaec07c6e7ae2a2a6f54e2a16b32c8bf26">◆ </a></span>toDb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long Hurricane::DbU::toDb </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the external value associated to the unit <code><unit></code> according to the current precision. This function do nothing apart from a type cast. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#ga4233772b1b3e68f3ec723c7509ea87ff">Hurricane::DbU::getDb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga318d673386c9424e07c12efd598c730d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga318d673386c9424e07c12efd598c730d">◆ </a></span>toGrid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::toGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the value expressed as a number of founder grid steps associated to the unit <code><unit></code> according to the current precision. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#gad4485d0d7b5fd7ae87b32f165155c0a2">Hurricane::DbU::getGrid()</a>, and <a class="el" href="group__DbUGroup.html#ga4923a9a443871282ad7d331be2a2a5d4">Hurricane::DbU::toLambda()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4923a9a443871282ad7d331be2a2a5d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4923a9a443871282ad7d331be2a2a5d4">◆ </a></span>toLambda()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::toLambda </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the symbolic value (expressed as a number lambdas) associated to the unit <code><unit></code> according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga318d673386c9424e07c12efd598c730d">Hurricane::DbU::toGrid()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#gadea6b9a6e84243f70f3a5e2725b2c6d8">Hurricane::DbU::getLambda()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab901e9d5c12e878728178f113def6c45"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab901e9d5c12e878728178f113def6c45">◆ </a></span>toPhysical()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::toPhysical </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">UnitPower</a> </td>
|
|
<td class="paramname"><em>p</em> </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 class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the physical value of <code>u</code>, expressed in the power <code>p</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6169efbdd9b3d54a0bd8467c8f957fda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6169efbdd9b3d54a0bd8467c8f957fda">◆ </a></span>getPrecision()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned Hurricane::DbU::getPrecision </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the current precision (whose default is fixed to 1). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8756c9f0a32af5f601cd150e73b02c03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8756c9f0a32af5f601cd150e73b02c03">◆ </a></span>getMaximalPrecision()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned Hurricane::DbU::getMaximalPrecision </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the maximal precision allowed (currently fixed to 3). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga120a60b09b344d01c583567a1e489d9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga120a60b09b344d01c583567a1e489d9e">◆ </a></span>getResolution()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::getResolution </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the current resolution. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac93f9ba2a09105227e34bd05bcb1500c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac93f9ba2a09105227e34bd05bcb1500c">◆ </a></span>setGridsPerLambda()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hurricane::DbU::setGridsPerLambda </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>gridsPerLambda</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>flags</em> = <code>NoFlags</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> Sets how many founder grid steps makes one <em>lambda</em>. It must be an event integer otherwise an exception is thrown. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9a0359adbfafc356326f5c6adf57ff04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9a0359adbfafc356326f5c6adf57ff04">◆ </a></span>getGridsPerLambda()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::getGridsPerLambda </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> How many founder grid steps makes one <em>lambda</em>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga89ab8f8326c54113336086663ecf1d25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga89ab8f8326c54113336086663ecf1d25">◆ </a></span>setStringMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hurricane::DbU::setStringMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga50b5785bf4d75026c4c112caec3040a7">UnitPower</a> </td>
|
|
<td class="paramname"><em>p</em> = <code><a class="el" href="group__DbUGroup.html#gga50b5785bf4d75026c4c112caec3040a7a03e5923be5810db830626f2ca26319d6">Nano</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sets in which length the units are to be displayed by <a class="el" href="group__DbUGroup.html#gadc9c1a06b4296dbddcf711077113f4bd">getValueString()</a>. Avalaibles modes are : </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadc9c1a06b4296dbddcf711077113f4bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadc9c1a06b4296dbddcf711077113f4bd">◆ </a></span>getValueString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string Hurricane::DbU::getValueString </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Unit</a> </td>
|
|
<td class="paramname"><em>unit</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>mode</em> = <code>SmartTruncate</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A character string representing the external value of <code><unit></code>. The value is converted in the length according to <a class="el" href="group__DbUGroup.html#ga89ab8f8326c54113336086663ecf1d25">setStringMode()</a>: database, grid or symbolic.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>This string is shorter than the one we could print from the external value because non needed decimals are not drawn (nor the point if value is integer). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gace9a8644e7e80dcaed2a8a95deeb1622"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gace9a8644e7e80dcaed2a8a95deeb1622">◆ </a></span>setPrecision()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hurricane::DbU::setPrecision </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>precision</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>flags</em> = <code>NoFlags</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Allows to set the precision at a requested value. This must be done at the begining of the program (before the creation of the first unit) and not changed for the following (unless mandatory and for a temporary period because all existing units would be misinterpreted).</p>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>This function throws an exception if the requested precision is greater than the maximal one. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga202cc3aa3364c2224647a29dde047fae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga202cc3aa3364c2224647a29dde047fae">◆ </a></span>setRealSnapGridStep()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hurricane::DbU::setRealSnapGridStep </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>step</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the real (founder) grid step. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga09e46fcca6aaca94851adfa196e10170"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga09e46fcca6aaca94851adfa196e10170">◆ </a></span>getRealSnapGridStep()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::getRealSnapGridStep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the real (founder) grid step. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8746e486f153aa37ee469c1604eba5c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8746e486f153aa37ee469c1604eba5c0">◆ </a></span>getOnRealSnapGrid()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::getOnRealSnapGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">DbU::SnapMode</a> </td>
|
|
<td class="paramname"><em>mode</em> = <code><a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Nearest</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the snap point from the unit <code>u</code>, using the rounding mode <code>mode</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9ccd423c8f268ef54770f4663e6c9304"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9ccd423c8f268ef54770f4663e6c9304">◆ </a></span>setSymbolicSnapGridStep()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hurricane::DbU::setSymbolicSnapGridStep </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>step</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the symbolic grid step. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga687a9134729b107c42fb7f69596c4c3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga687a9134729b107c42fb7f69596c4c3b">◆ </a></span>getSymbolicSnapGridStep()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::getSymbolicSnapGridStep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the symbolic grid step. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad1b0c0f3680093cf5a63d901312c925d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad1b0c0f3680093cf5a63d901312c925d">◆ </a></span>getOnSymbolicSnapGrid()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::getOnSymbolicSnapGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">DbU::SnapMode</a> </td>
|
|
<td class="paramname"><em>mode</em> = <code><a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Nearest</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the snap point from the unit <code>u</code>, using the rounding mode <code>mode</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga87323d9038656dceabffc37d45de408a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga87323d9038656dceabffc37d45de408a">◆ </a></span>getOnCustomGrid()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::getOnCustomGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>step</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">DbU::SnapMode</a> </td>
|
|
<td class="paramname"><em>mode</em> = <code><a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a65e6f47eb16779b8974a80d6145a2db5">Nearest</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the snap point from the unit <code>u</code>, with grid step <code>step</code> using the rounding mode <code>mode</code>. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#ga9419025221579f4277475c65655be3dc">Hurricane::DbU::getOnPhysicalGrid()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9419025221579f4277475c65655be3dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9419025221579f4277475c65655be3dc">◆ </a></span>getOnPhysicalGrid()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::getOnPhysicalGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga1082168d6f9956ebba22ab8bbec21637">DbU::SnapMode</a> </td>
|
|
<td class="paramname"><em>mode</em> = <code><a class="el" href="group__DbUGroup.html#gga1082168d6f9956ebba22ab8bbec21637a8ce92cf7ff7627c46baf85612f9ad847">Superior</a></code> </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 class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the physical grid unit nearest to <code>u</code>, with <code>mode</code> rounding. using the rounding mode <code>mode</code>. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga87323d9038656dceabffc37d45de408a">Hurricane::DbU::getOnCustomGrid()</a>, and <a class="el" href="group__DbUGroup.html#ga1d4bac6e3b68c8cd44b345de3b425753">Hurricane::DbU::grid()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacd77957381fb93fc4203bdca215e0b48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacd77957381fb93fc4203bdca215e0b48">◆ </a></span>db()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::db </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the value <code><value></code> according to the current precision. This function do nothing apart from a cast. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#gaec69d65ec1651c2feea24c5931f4580b">Hurricane::DbU::fromDb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1d4bac6e3b68c8cd44b345de3b425753"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1d4bac6e3b68c8cd44b345de3b425753">◆ </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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::grid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the <em>grid</em> value <code><value></code> according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga367e1d1b5ac1df076745550cba8a83c1">Hurricane::DbU::fromGrid()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="group__DbUGroup.html#ga9419025221579f4277475c65655be3dc">Hurricane::DbU::getOnPhysicalGrid()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa1ba98acc939ff1c370c18544a5e0dce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa1ba98acc939ff1c370c18544a5e0dce">◆ </a></span>lambda()</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="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> Hurricane::DbU::lambda </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the unit corresponding to the <em>symbolic</em> value <code><value></code> according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga4b570755b19ea9ff0f2f258a221bd935">Hurricane::DbU::fromLambda()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4233772b1b3e68f3ec723c7509ea87ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4233772b1b3e68f3ec723c7509ea87ff">◆ </a></span>getDb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long Hurricane::DbU::getDb </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the external value associated to the unit <code><unit></code> according to the current precision. This function do nothing apart from a type cast. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#gaec07c6e7ae2a2a6f54e2a16b32c8bf26">Hurricane::DbU::toDb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad4485d0d7b5fd7ae87b32f165155c0a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad4485d0d7b5fd7ae87b32f165155c0a2">◆ </a></span>getGrid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::getGrid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the value expressed as a number of founder grid steps associated to the unit <code><unit></code> according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga318d673386c9424e07c12efd598c730d">Hurricane::DbU::toGrid()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadea6b9a6e84243f70f3a5e2725b2c6d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadea6b9a6e84243f70f3a5e2725b2c6d8">◆ </a></span>getLambda()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double Hurricane::DbU::getLambda </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">DbU::Unit</a> </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><b>Returns:</b> the symbolic value (expressed as a number lambdas) associated to the unit <code><unit></code> according to the current precision. </p>
|
|
|
|
<p class="reference">References <a class="el" href="group__DbUGroup.html#ga4923a9a443871282ad7d331be2a2a5d4">Hurricane::DbU::toLambda()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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">Hurricane VLSI Database</td>
|
|
<td class="RFooter"><small>Copyright © 2000-2020 Bull S.A. All rights reserved</small></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|