mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 23:57:58 +08:00
406 lines
24 KiB
HTML
406 lines
24 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_Terminator 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-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="../../d7/d1d/class_o_n___terminator-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_Terminator Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="../../d1/dbf/opennurbs__terminator_8h_source.html">opennurbs_terminator.h</a>></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:af747120bc6042550e073aaeaa62c792f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#af747120bc6042550e073aaeaa62c792f">ON_Terminator</a> ()</td></tr>
|
|
<tr class="separator:af747120bc6042550e073aaeaa62c792f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5c393cf03f61f81c7425032d08a83e2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#aa5c393cf03f61f81c7425032d08a83e2">~ON_Terminator</a> ()</td></tr>
|
|
<tr class="separator:aa5c393cf03f61f81c7425032d08a83e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e05e2d0600c001d828c10de0991d22c"><td class="memItemLeft" align="right" valign="top">ON__UINT_PTR </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#a4e05e2d0600c001d828c10de0991d22c">CallbackContext</a> () const</td></tr>
|
|
<tr class="separator:a4e05e2d0600c001d828c10de0991d22c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25fbf15125ebdcf385ad6b5b7440f584"><td class="memItemLeft" align="right" valign="top">ON__UINT_PTR </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#a25fbf15125ebdcf385ad6b5b7440f584">CallbackFunction</a> () const</td></tr>
|
|
<tr class="separator:a25fbf15125ebdcf385ad6b5b7440f584"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a665a583aeb9c5f152e48d2e6aef533e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#a665a583aeb9c5f152e48d2e6aef533e5">RequestTermination</a> ()</td></tr>
|
|
<tr class="memdesc:a665a583aeb9c5f152e48d2e6aef533e5"><td class="mdescLeft"> </td><td class="mdescRight">Sets m_bTerminationRequested = true. All future calls to TerminationRequested(this) will return true. <a href="#a665a583aeb9c5f152e48d2e6aef533e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a665a583aeb9c5f152e48d2e6aef533e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2070e70db7ccc68a3af8769472c41a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#ab2070e70db7ccc68a3af8769472c41a7">SetTerminationQueryCallbackFunction</a> (bool(*callback_function)(ON__UINT_PTR context), ON__UINT_PTR callback_context)</td></tr>
|
|
<tr class="memdesc:ab2070e70db7ccc68a3af8769472c41a7"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that is called when a calculation wants to determine if the calculation should stop or continue. <a href="#ab2070e70db7ccc68a3af8769472c41a7">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2070e70db7ccc68a3af8769472c41a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0d4beb109848233be52494fc5804cd3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#ab0d4beb109848233be52494fc5804cd3">SetThreadId</a> (ON__UINT_PTR thread_id)</td></tr>
|
|
<tr class="separator:ab0d4beb109848233be52494fc5804cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae746dfbc4b0ad60ab85bab3f1c975d5f"><td class="memItemLeft" align="right" valign="top">ON__UINT_PTR </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#ae746dfbc4b0ad60ab85bab3f1c975d5f">ThreadId</a> () const</td></tr>
|
|
<tr class="separator:ae746dfbc4b0ad60ab85bab3f1c975d5f"><td class="memSeparator" colspan="2"> </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:a0a279621a45a5b3b5a1b4baa076e2a08"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#a0a279621a45a5b3b5a1b4baa076e2a08">RequestTermination</a> (<a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> *terminator)</td></tr>
|
|
<tr class="memdesc:a0a279621a45a5b3b5a1b4baa076e2a08"><td class="mdescLeft"> </td><td class="mdescRight">If terminator is not nullptr, sets terminator->m_bTerminationRequested = true. If terminator is not nullptr, all future calls to TerminationRequested(terminator) will return true. <a href="#a0a279621a45a5b3b5a1b4baa076e2a08">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a279621a45a5b3b5a1b4baa076e2a08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8da087534f4a36db658a09343375554"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#ae8da087534f4a36db658a09343375554">TerminationRequested</a> (<a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> *terminator)</td></tr>
|
|
<tr class="memdesc:ae8da087534f4a36db658a09343375554"><td class="mdescLeft"> </td><td class="mdescRight">A calculation calls ON_Terminator::TerminationRequested(terminator) to determine if it should continue or quit. <a href="#ae8da087534f4a36db658a09343375554">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8da087534f4a36db658a09343375554"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2ad4ca8f0f6c0fe5e3f67f782a67dce"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da9/class_o_n___terminator.html#ad2ad4ca8f0f6c0fe5e3f67f782a67dce">TerminationRequestedExpert</a> (<a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> *terminator, ON__UINT64 callback_delta)</td></tr>
|
|
<tr class="memdesc:ad2ad4ca8f0f6c0fe5e3f67f782a67dce"><td class="mdescLeft"> </td><td class="mdescRight">An expert user function to determine if a calculation should continue. <a href="#ad2ad4ca8f0f6c0fe5e3f67f782a67dce">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2ad4ca8f0f6c0fe5e3f67f782a67dce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af747120bc6042550e073aaeaa62c792f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af747120bc6042550e073aaeaa62c792f">◆ </a></span>ON_Terminator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_Terminator::ON_Terminator </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa5c393cf03f61f81c7425032d08a83e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5c393cf03f61f81c7425032d08a83e2">◆ </a></span>~ON_Terminator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_Terminator::~ON_Terminator </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4e05e2d0600c001d828c10de0991d22c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e05e2d0600c001d828c10de0991d22c">◆ </a></span>CallbackContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON__UINT_PTR ON_Terminator::CallbackContext </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25fbf15125ebdcf385ad6b5b7440f584"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25fbf15125ebdcf385ad6b5b7440f584">◆ </a></span>CallbackFunction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON__UINT_PTR ON_Terminator::CallbackFunction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a665a583aeb9c5f152e48d2e6aef533e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a665a583aeb9c5f152e48d2e6aef533e5">◆ </a></span>RequestTermination() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Terminator::RequestTermination </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets m_bTerminationRequested = true. All future calls to TerminationRequested(this) will return true. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a279621a45a5b3b5a1b4baa076e2a08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a279621a45a5b3b5a1b4baa076e2a08">◆ </a></span>RequestTermination() <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 void ON_Terminator::RequestTermination </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> * </td>
|
|
<td class="paramname"><em>terminator</em></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>If terminator is not nullptr, sets terminator->m_bTerminationRequested = true. If terminator is not nullptr, all future calls to TerminationRequested(terminator) will return true. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">terminator</td><td>[in] (can be nullptr)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This is convenience function and is identical to the code</p>
|
|
<p>if (nullptr != terminator) terminator-><a class="el" href="../../d9/da9/class_o_n___terminator.html#a665a583aeb9c5f152e48d2e6aef533e5" title="Sets m_bTerminationRequested = true. All future calls to TerminationRequested(this) will return true...">RequestTermination()</a>; </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2070e70db7ccc68a3af8769472c41a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2070e70db7ccc68a3af8769472c41a7">◆ </a></span>SetTerminationQueryCallbackFunction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Terminator::SetTerminationQueryCallbackFunction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool(*)(ON__UINT_PTR context) </td>
|
|
<td class="paramname"><em>callback_function</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ON__UINT_PTR </td>
|
|
<td class="paramname"><em>callback_context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the function that is called when a calculation wants to determine if the calculation should stop or continue. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback_function</td><td>[in]<ul>
|
|
<li>The function that is called when a calculation wants to determine if the calculation should stop or continue.</li>
|
|
<li>If this callback function returns true, the calculation will terminate as soon as possible.</li>
|
|
<li>If this callback function returns false, the calculation will continue.</li>
|
|
<li>The calculation thread calls in this callback function.</li>
|
|
<li>The callback function should do something that is fast and simple. Parameters passed to the callback function:</li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">context</td><td>[in] the value of callback_context.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> bStopCalculation = <span class="keyword">false</span>;</div><div class="line"></div><div class="line"><span class="keywordtype">bool</span> StopCalculation( ON__UINT_PTR context )</div><div class="line">{</div><div class="line"> <span class="keywordflow">if</span> ( 0 != context )</div><div class="line"> {</div><div class="line"> <span class="keyword">const</span> <span class="keywordtype">bool</span>* p = (<span class="keyword">const</span> <span class="keywordtype">bool</span>*)context;</div><div class="line"> <span class="keywordflow">if</span> ( *p )</div><div class="line"> <span class="keywordflow">return</span> <span class="keyword">true</span>; <span class="comment">// terminate calculation as soon as possible</span></div><div class="line"> }</div><div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// continue calculation</span></div><div class="line">}</div><div class="line"></div><div class="line">...</div><div class="line"></div><div class="line">ON_Terminator terminator;</div><div class="line">terminator.SetTerminationQueryCallbackFunction(StopCalculation,(ON__UINT_PTR)(&bStopCalculation));</div><div class="line">...</div><div class="line">Pass &terminator to a calculation and then <span class="keyword">set</span> bStopCalculation = <span class="keyword">true</span> to terminate it.</div><div class="line">The calculation will generally be running in another thread, but can be in the same</div><div class="line">thread <span class="keywordflow">if</span> it is structured to pump windows messages or something similar.</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ab0d4beb109848233be52494fc5804cd3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0d4beb109848233be52494fc5804cd3">◆ </a></span>SetThreadId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Terminator::SetThreadId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ON__UINT_PTR </td>
|
|
<td class="paramname"><em>thread_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae8da087534f4a36db658a09343375554"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8da087534f4a36db658a09343375554">◆ </a></span>TerminationRequested()</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_Terminator::TerminationRequested </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> * </td>
|
|
<td class="paramname"><em>terminator</em></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>A calculation calls ON_Terminator::TerminationRequested(terminator) to determine if it should continue or quit. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">terminator</td><td>[in] A pointer to an <a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> or null pointer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the calculation should terminate as soon as possible. False if the calculation should continue. </dd></dl>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">void</span> MyLongCalculation( ..., <a class="code" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a>* terminator, ...)</div><div class="line">{</div><div class="line"> <span class="keywordflow">for</span> ( i = 0; i < count; i++ )</div><div class="line"> {</div><div class="line"> <span class="keywordflow">if</span> ( <a class="code" href="../../d9/da9/class_o_n___terminator.html#ae8da087534f4a36db658a09343375554">ON_Terminator::TerminationRequested</a>(terminator) )</div><div class="line"> <span class="keywordflow">break</span>;</div><div class="line"> ...</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ad2ad4ca8f0f6c0fe5e3f67f782a67dce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2ad4ca8f0f6c0fe5e3f67f782a67dce">◆ </a></span>TerminationRequestedExpert()</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_Terminator::TerminationRequestedExpert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> * </td>
|
|
<td class="paramname"><em>terminator</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ON__UINT64 </td>
|
|
<td class="paramname"><em>callback_delta</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An expert user function to determine if a calculation should continue. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">terminator</td><td>[in] A pointer to an <a class="el" href="../../d9/da9/class_o_n___terminator.html">ON_Terminator</a> or null pointer.</td></tr>
|
|
<tr><td class="paramname">callback_delta</td><td>[in] Minimum amount of time to delay between calls to the registered callback function in clock() time units. 0 will omit making any call to the registered function. ON_Terminator::TerminationRequested( terminator ) uses a value of callback_delta = CLOCKS_PER_SEC/10 meaning a maximum of 10 callbacks per second.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the calculation should terminate as soon as possible. False if the calculation should continue. </dd></dl>
|
|
<p>In general, call the ON_Terminator::TerminationRequested( terminator ). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae746dfbc4b0ad60ab85bab3f1c975d5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae746dfbc4b0ad60ab85bab3f1c975d5f">◆ </a></span>ThreadId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON__UINT_PTR ON_Terminator::ThreadId </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</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:32 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>
|