Files
opennurbs/6/d6/d11/class_o_n___number_formatter.html
Bozo 832ccb5c1a Publish!
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

486 lines
21 KiB
HTML

<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_NumberFormatter Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- bootstrap -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- smartmenus -->
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
</head>
<body>
<!-- <div class="version-banner">
Go back to the <a href="/">main site</a>...
</div> -->
<div class="container">
<!-- navbar -->
<nav class="navbar navbar-default">
<div class="container-fluid">
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
<div class="navbar-collapse collapse" id="main-nav-placeholder">
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
<ul class="dropdown-menu">
<li><a href="#">Latest (6.x)</a></li>
<li class="disabled"><a href="#">WIP (7.x)</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="page-content">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="../../d9/df6/class_o_n___number_formatter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_NumberFormatter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>ON_Table class.
<a href="../../d6/d11/class_o_n___number_formatter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d5/d03/opennurbs__dimensionformat_8h_source.html">opennurbs_dimensionformat.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a88e293a7393b159ee52681f1faf3f089"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a88e293a7393b159ee52681f1faf3f089">FormatAngleStringDecimal</a> (double angle_radians, int resolution, double roundoff, <a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> zero_suppression, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;formatted_string)</td></tr>
<tr class="separator:a88e293a7393b159ee52681f1faf3f089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab212e31502d9012f6fb36471798d1657"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#ab212e31502d9012f6fb36471798d1657">FormatAngleStringDMS</a> (double angle_degrees, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;formatted_string)</td></tr>
<tr class="separator:ab212e31502d9012f6fb36471798d1657"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a914656f8164b26486cfc030b583c2c28"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a914656f8164b26486cfc030b583c2c28">FormatLength</a> (double distance, <a class="el" href="../../d8/df8/class_o_n___dim_style.html#af27da5e20982ca9c8efeb3a4fab055c4">ON_DimStyle::LengthDisplay</a> output_lengthdisplay, double round_off, int resolution, <a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> zero_suppress, bool bracket_fractions, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;output)</td></tr>
<tr class="separator:a914656f8164b26486cfc030b583c2c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71c6c78b444dae70b622895136c3232c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a71c6c78b444dae70b622895136c3232c">FormatNumber</a> (double distance, <a class="el" href="../../d8/df8/class_o_n___dim_style.html#aeece0b5c27a6d625454cdeb931352840">ON_DimStyle::OBSOLETE_length_format</a> output_lengthformat, double round_off, int resolution, <a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> zero_suppress, bool bracket_fractions, <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;output)</td></tr>
<tr class="separator:a71c6c78b444dae70b622895136c3232c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07a106c692ee8eb209d1beda2f2b2ee4"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a07a106c692ee8eb209d1beda2f2b2ee4">Fraction</a> (double value, int &amp;wholenumber, int &amp;numerator, int &amp;denominator, int precision)</td></tr>
<tr class="separator:a07a106c692ee8eb209d1beda2f2b2ee4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cbba60cc0ac057c858d8961292c6bc0"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a7cbba60cc0ac057c858d8961292c6bc0">RoundOff</a> (double number, double round_off)</td></tr>
<tr class="separator:a7cbba60cc0ac057c858d8961292c6bc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e6c07448fe45f2ef9c58756c4811d1f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a1e6c07448fe45f2ef9c58756c4811d1f">SuppressZeros</a> (<a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;dist, <a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> sz)</td></tr>
<tr class="separator:a1e6c07448fe45f2ef9c58756c4811d1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a482f8723cbe84ff427ad2cb29491e384"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d11/class_o_n___number_formatter.html#a482f8723cbe84ff427ad2cb29491e384">bFormatIsAccurate</a></td></tr>
<tr class="separator:a482f8723cbe84ff427ad2cb29491e384"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>ON_Table class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a88e293a7393b159ee52681f1faf3f089"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88e293a7393b159ee52681f1faf3f089">&#9670;&nbsp;</a></span>FormatAngleStringDecimal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_NumberFormatter::FormatAngleStringDecimal </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>angle_radians</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>roundoff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a>&#160;</td>
<td class="paramname"><em>zero_suppression</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;&#160;</td>
<td class="paramname"><em>formatted_string</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab212e31502d9012f6fb36471798d1657"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab212e31502d9012f6fb36471798d1657">&#9670;&nbsp;</a></span>FormatAngleStringDMS()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_NumberFormatter::FormatAngleStringDMS </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>angle_degrees</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;&#160;</td>
<td class="paramname"><em>formatted_string</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a914656f8164b26486cfc030b583c2c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a914656f8164b26486cfc030b583c2c28">&#9670;&nbsp;</a></span>FormatLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_NumberFormatter::FormatLength </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d8/df8/class_o_n___dim_style.html#af27da5e20982ca9c8efeb3a4fab055c4">ON_DimStyle::LengthDisplay</a>&#160;</td>
<td class="paramname"><em>output_lengthdisplay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>round_off</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a>&#160;</td>
<td class="paramname"><em>zero_suppress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>bracket_fractions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;&#160;</td>
<td class="paramname"><em>output</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a71c6c78b444dae70b622895136c3232c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71c6c78b444dae70b622895136c3232c">&#9670;&nbsp;</a></span>FormatNumber()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ON_NumberFormatter::FormatNumber </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d8/df8/class_o_n___dim_style.html#aeece0b5c27a6d625454cdeb931352840">ON_DimStyle::OBSOLETE_length_format</a>&#160;</td>
<td class="paramname"><em>output_lengthformat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>round_off</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>resolution</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a>&#160;</td>
<td class="paramname"><em>zero_suppress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>bracket_fractions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;&#160;</td>
<td class="paramname"><em>output</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a07a106c692ee8eb209d1beda2f2b2ee4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07a106c692ee8eb209d1beda2f2b2ee4">&#9670;&nbsp;</a></span>Fraction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ON_NumberFormatter::Fraction </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;&#160;</td>
<td class="paramname"><em>wholenumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;&#160;</td>
<td class="paramname"><em>numerator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;&#160;</td>
<td class="paramname"><em>denominator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>precision</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7cbba60cc0ac057c858d8961292c6bc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cbba60cc0ac057c858d8961292c6bc0">&#9670;&nbsp;</a></span>RoundOff()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static double ON_NumberFormatter::RoundOff </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>round_off</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1e6c07448fe45f2ef9c58756c4811d1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e6c07448fe45f2ef9c58756c4811d1f">&#9670;&nbsp;</a></span>SuppressZeros()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ON_NumberFormatter::SuppressZeros </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;&#160;</td>
<td class="paramname"><em>dist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d8/df8/class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a>&#160;</td>
<td class="paramname"><em>sz</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a482f8723cbe84ff427ad2cb29491e384"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a482f8723cbe84ff427ad2cb29491e384">&#9670;&nbsp;</a></span>bFormatIsAccurate</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ON_NumberFormatter::bFormatIsAccurate</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
</div> <!-- page-content -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 3 2018 11:08:31 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13
</small></address>
</div> <!-- container -->
<!-- doxy-boot -->
<script type="text/javascript" src="../../doxy-boot.js"></script>
</body>
</html>