lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-03-30 23:57:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
2d5c650ea1adf3b22657713582b3c3e736030995
opennurbs/6/class_o_n___progress_step_counter.html
Bozo 2d5c650ea1 Publish! 
Generated from TESTING
2018-01-26 12:35:52 +00:00

428 lines
22 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_ProgressStepCounter 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="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openNURBS SDK Help
&#160;<span id="projectnumber">6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_o_n___progress_step_counter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_ProgressStepCounter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="opennurbs__progress__reporter_8h_source.html">opennurbs_progress_reporter.h</a>&gt;</code></p>
<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:aba0247233e4f685f2d6abb413c82a68d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#aba0247233e4f685f2d6abb413c82a68d">ON_ProgressStepCounter</a> ()=default</td></tr>
<tr class="memdesc:aba0247233e4f685f2d6abb413c82a68d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class makes it easy for functions to use a progress reporter. <a href="#aba0247233e4f685f2d6abb413c82a68d">More...</a><br /></td></tr>
<tr class="separator:aba0247233e4f685f2d6abb413c82a68d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a938c4e369ffddda2594b9b473142bd67"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a938c4e369ffddda2594b9b473142bd67">ON_ProgressStepCounter</a> (const <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> &amp;)=default</td></tr>
<tr class="separator:a938c4e369ffddda2594b9b473142bd67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a350cdd40adde08ba66fef7c652b4fa96"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a350cdd40adde08ba66fef7c652b4fa96">~ON_ProgressStepCounter</a> ()=default</td></tr>
<tr class="separator:a350cdd40adde08ba66fef7c652b4fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fface8132d7ca751600f4e4e1cfd7df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a8fface8132d7ca751600f4e4e1cfd7df">Finished</a> ()</td></tr>
<tr class="separator:a8fface8132d7ca751600f4e4e1cfd7df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a865551c45deef25f1b7e3acff8f2d804"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a865551c45deef25f1b7e3acff8f2d804">IncrementStep</a> ()</td></tr>
<tr class="separator:a865551c45deef25f1b7e3acff8f2d804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a35b5d97118324d04e7aa8fc346bbe4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a2a35b5d97118324d04e7aa8fc346bbe4">operator=</a> (const <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> &amp;)=default</td></tr>
<tr class="separator:a2a35b5d97118324d04e7aa8fc346bbe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01a9413c122aa45aa49f378121c79c1b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a01a9413c122aa45aa49f378121c79c1b">Progress</a> () const</td></tr>
<tr class="separator:a01a9413c122aa45aa49f378121c79c1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0e4f257205c2be528556e96eb19f19a"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#aa0e4f257205c2be528556e96eb19f19a">Step</a> () const</td></tr>
<tr class="separator:aa0e4f257205c2be528556e96eb19f19a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb5691e9e11a3991adb9e6afcaf9329"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#aebb5691e9e11a3991adb9e6afcaf9329">StepCount</a> () const</td></tr>
<tr class="separator:aebb5691e9e11a3991adb9e6afcaf9329"><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-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5d5102a72420b2eb10ba835199528817"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a5d5102a72420b2eb10ba835199528817">Create</a> (<a class="el" href="class_o_n___progress_reporter.html">ON_ProgressReporter</a> *progress_reporter, unsigned int step_count)</td></tr>
<tr class="separator:a5d5102a72420b2eb10ba835199528817"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657e26bde2589da185cbb29c15c86613"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a657e26bde2589da185cbb29c15c86613">Create</a> (<a class="el" href="class_o_n___progress_reporter.html">ON_ProgressReporter</a> *progress_reporter, unsigned int step_count, double progress_interval_start, double progress_interval_finish, unsigned int maximum_progress_reports)</td></tr>
<tr class="separator:a657e26bde2589da185cbb29c15c86613"><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:a979060dd30e7babaa2b0cb1bbd8da9de"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___progress_step_counter.html#a979060dd30e7babaa2b0cb1bbd8da9de">Empty</a></td></tr>
<tr class="separator:a979060dd30e7babaa2b0cb1bbd8da9de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aba0247233e4f685f2d6abb413c82a68d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0247233e4f685f2d6abb413c82a68d">&#9670;&nbsp;</a></span>ON_ProgressStepCounter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ON_ProgressStepCounter::ON_ProgressStepCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This class makes it easy for functions to use a progress reporter. </p>
</div>
</div>
<a id="a350cdd40adde08ba66fef7c652b4fa96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a350cdd40adde08ba66fef7c652b4fa96">&#9670;&nbsp;</a></span>~ON_ProgressStepCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ON_ProgressStepCounter::~ON_ProgressStepCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a938c4e369ffddda2594b9b473142bd67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a938c4e369ffddda2594b9b473142bd67">&#9670;&nbsp;</a></span>ON_ProgressStepCounter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ON_ProgressStepCounter::ON_ProgressStepCounter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5d5102a72420b2eb10ba835199528817"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d5102a72420b2eb10ba835199528817">&#9670;&nbsp;</a></span>Create() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> ON_ProgressStepCounter::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_o_n___progress_reporter.html">ON_ProgressReporter</a> *&#160;</td>
<td class="paramname"><em>progress_reporter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>step_count</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">
<p>Description: When you have a process that needs to call a <a class="el" href="class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress()</a> a reasonable number of times and you can calculate the number of steps your process takes, then <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> will handle all the details. Parameters: progress_reporter - [in] Parameter passed to <a class="el" href="class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress()</a>. step_count - [in] Number of steps. Remarks: This will create a <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> that will call ON_ProgressReporter::ReportProgress(progress_reporter) at most 101 times. The first call reports progress 0.0. The last call reports progress 1.0. </p>
</div>
</div>
<a id="a657e26bde2589da185cbb29c15c86613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a657e26bde2589da185cbb29c15c86613">&#9670;&nbsp;</a></span>Create() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> ON_ProgressStepCounter::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_o_n___progress_reporter.html">ON_ProgressReporter</a> *&#160;</td>
<td class="paramname"><em>progress_reporter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>step_count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>progress_interval_start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>progress_interval_finish</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>maximum_progress_reports</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">
<p>Description: When you have a process that needs to call a <a class="el" href="class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress()</a> a reasonable number of times and you can calculate the number of steps your process takes, then <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> will handle all the details. Parameters: progress_reporter - [in] Parameter passed to <a class="el" href="class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress()</a>. step_count - [in] Number of steps. progress_interval_start - [in] progress_interval_finish - [in] 0.0 &lt;= progress_interval_start &lt; progress_interval_finish &lt;= 1.0 maximum_progress_reports - [in] Maximum number of times to call <a class="el" href="class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress()</a> after the initial call reporting progress of progress_interval_start. 10 to 100 are good values. </p>
</div>
</div>
<a id="a8fface8132d7ca751600f4e4e1cfd7df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fface8132d7ca751600f4e4e1cfd7df">&#9670;&nbsp;</a></span>Finished()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_ProgressStepCounter::Finished </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Call <a class="el" href="class_o_n___progress_step_counter.html#a8fface8132d7ca751600f4e4e1cfd7df">Finished()</a> after you complete the process. </p>
</div>
</div>
<a id="a865551c45deef25f1b7e3acff8f2d804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a865551c45deef25f1b7e3acff8f2d804">&#9670;&nbsp;</a></span>IncrementStep()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_ProgressStepCounter::IncrementStep </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Call <a class="el" href="class_o_n___progress_step_counter.html#a865551c45deef25f1b7e3acff8f2d804">IncrementStep()</a> after you complete each step. </p>
</div>
</div>
<a id="a2a35b5d97118324d04e7aa8fc346bbe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a35b5d97118324d04e7aa8fc346bbe4">&#9670;&nbsp;</a></span>operator=()</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="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a>&amp; ON_ProgressStepCounter::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a01a9413c122aa45aa49f378121c79c1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01a9413c122aa45aa49f378121c79c1b">&#9670;&nbsp;</a></span>Progress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ON_ProgressStepCounter::Progress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa0e4f257205c2be528556e96eb19f19a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0e4f257205c2be528556e96eb19f19a">&#9670;&nbsp;</a></span>Step()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ON_ProgressStepCounter::Step </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aebb5691e9e11a3991adb9e6afcaf9329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebb5691e9e11a3991adb9e6afcaf9329">&#9670;&nbsp;</a></span>StepCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ON_ProgressStepCounter::StepCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a979060dd30e7babaa2b0cb1bbd8da9de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a979060dd30e7babaa2b0cb1bbd8da9de">&#9670;&nbsp;</a></span>Empty</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="class_o_n___progress_step_counter.html">ON_ProgressStepCounter</a> ON_ProgressStepCounter::Empty</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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 25 2018 17:01:11 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink