Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
81a9ccc24fa979a10187970d71e8aa993454af4c
entt/classentt_1_1Process.html
Michele Caini 89909a0db3 API reference v2.6.1
2018-06-04 08:58:07 +02:00

515 lines
26 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>entt: entt::Process&lt; Derived, Delta &gt; Class Template 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">entt
&#160;<span id="projectnumber">2.6.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1Process.html">Process</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classentt_1_1Process-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::Process&lt; Derived, Delta &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for processes.
<a href="classentt_1_1Process.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="process_8hpp_source.html">process.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aaa304f69a0344fffd3a53daa922284ad"><td class="memItemLeft" align="right" valign="top"><a id="aaa304f69a0344fffd3a53daa922284ad"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#aaa304f69a0344fffd3a53daa922284ad">delta_type</a> = Delta</td></tr>
<tr class="memdesc:aaa304f69a0344fffd3a53daa922284ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type used to provide elapsed time. <br /></td></tr>
<tr class="separator:aaa304f69a0344fffd3a53daa922284ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abcfd11c007770ec8bd997333b00f5f8b"><td class="memItemLeft" align="right" valign="top"><a id="abcfd11c007770ec8bd997333b00f5f8b"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#abcfd11c007770ec8bd997333b00f5f8b">~Process</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:abcfd11c007770ec8bd997333b00f5f8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:abcfd11c007770ec8bd997333b00f5f8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7a9c2acd493969267ce4a6d2e2884b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#ae7a9c2acd493969267ce4a6d2e2884b8">abort</a> (const bool immediately=false) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ae7a9c2acd493969267ce4a6d2e2884b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aborts a process if it's still alive. <a href="#ae7a9c2acd493969267ce4a6d2e2884b8">More...</a><br /></td></tr>
<tr class="separator:ae7a9c2acd493969267ce4a6d2e2884b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad18ce3558d2325d622fb2b8ab51c49d5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#ad18ce3558d2325d622fb2b8ab51c49d5">alive</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ad18ce3558d2325d622fb2b8ab51c49d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process is either running or paused. <a href="#ad18ce3558d2325d622fb2b8ab51c49d5">More...</a><br /></td></tr>
<tr class="separator:ad18ce3558d2325d622fb2b8ab51c49d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08265296592bcc0e5a6632b7067329b9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a08265296592bcc0e5a6632b7067329b9">dead</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a08265296592bcc0e5a6632b7067329b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process is already terminated. <a href="#a08265296592bcc0e5a6632b7067329b9">More...</a><br /></td></tr>
<tr class="separator:a08265296592bcc0e5a6632b7067329b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e320da0927d9ac83dc829d0aee8a310"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a3e320da0927d9ac83dc829d0aee8a310">paused</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a3e320da0927d9ac83dc829d0aee8a310"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process is currently paused. <a href="#a3e320da0927d9ac83dc829d0aee8a310">More...</a><br /></td></tr>
<tr class="separator:a3e320da0927d9ac83dc829d0aee8a310"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4e618f12f5cf18d978557ea793b697d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#aa4e618f12f5cf18d978557ea793b697d">rejected</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aa4e618f12f5cf18d978557ea793b697d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process terminated with errors. <a href="#aa4e618f12f5cf18d978557ea793b697d">More...</a><br /></td></tr>
<tr class="separator:aa4e618f12f5cf18d978557ea793b697d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9298c55069b27d4ffa005f4345be4d59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a9298c55069b27d4ffa005f4345be4d59">tick</a> (const Delta delta, void *data=nullptr)</td></tr>
<tr class="memdesc:a9298c55069b27d4ffa005f4345be4d59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates a process and its internal state if required. <a href="#a9298c55069b27d4ffa005f4345be4d59">More...</a><br /></td></tr>
<tr class="separator:a9298c55069b27d4ffa005f4345be4d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ae90a29bf2afabf6a14aec0e1d3809a0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#ae90a29bf2afabf6a14aec0e1d3809a0f">succeed</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ae90a29bf2afabf6a14aec0e1d3809a0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates a process with success if it's still alive. <a href="#ae90a29bf2afabf6a14aec0e1d3809a0f">More...</a><br /></td></tr>
<tr class="separator:ae90a29bf2afabf6a14aec0e1d3809a0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa46a0784a199e1044c50e8aa34eea1bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#aa46a0784a199e1044c50e8aa34eea1bb">fail</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aa46a0784a199e1044c50e8aa34eea1bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates a process with errors if it's still alive. <a href="#aa46a0784a199e1044c50e8aa34eea1bb">More...</a><br /></td></tr>
<tr class="separator:aa46a0784a199e1044c50e8aa34eea1bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f2f865b2c4f0c7cf2d82786ecb50f5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a1f2f865b2c4f0c7cf2d82786ecb50f5f">pause</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a1f2f865b2c4f0c7cf2d82786ecb50f5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops a process if it's in a running state. <a href="#a1f2f865b2c4f0c7cf2d82786ecb50f5f">More...</a><br /></td></tr>
<tr class="separator:a1f2f865b2c4f0c7cf2d82786ecb50f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb2057ef29594395ef68b965e6b27c7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#aeb2057ef29594395ef68b965e6b27c7e">unpause</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aeb2057ef29594395ef68b965e6b27c7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restarts a process if it's paused. <a href="#aeb2057ef29594395ef68b965e6b27c7e">More...</a><br /></td></tr>
<tr class="separator:aeb2057ef29594395ef68b965e6b27c7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Derived, typename Delta&gt;<br />
class entt::Process&lt; Derived, Delta &gt;</h3>
<p>Base class for processes. </p>
<p>This class stays true to the CRTP idiom. Derived classes must specify what's the intended type for elapsed times.<br />
A process should expose publicly the following member functions whether required:</p>
<ul>
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> update(Delta, <span class="keywordtype">void</span> *);</div></div><!-- fragment --><p class="startli">It's invoked once per tick until a process is explicitly aborted or it terminates either with or without errors. Even though it's not mandatory to declare this member function, as a rule of thumb each process should at least define it to work properly. The <code>void *</code> parameter is an opaque pointer to user data (if any) forwarded directly to the process during an update.</p>
</li>
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> init(<span class="keywordtype">void</span> *);</div></div><!-- fragment --><p class="startli">It's invoked at the first tick, immediately before an update. The <code>void *</code> parameter is an opaque pointer to user data (if any) forwarded directly to the process during an update.</p>
</li>
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> succeeded();</div></div><!-- fragment --><p class="startli">It's invoked in case of success, immediately after an update and during the same tick.</p>
</li>
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> failed();</div></div><!-- fragment --><p class="startli">It's invoked in case of errors, immediately after an update and during the same tick.</p>
</li>
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> aborted();</div></div><!-- fragment --><p class="startli">It's invoked only if a process is explicitly aborted. There is no guarantee that it executes in the same tick, this depends solely on whether the process is aborted immediately or not.</p>
</li>
</ul>
<p>Derived classes can change the internal state of a process by invoking the <code>succeed</code> and <code>fail</code> protected member functions and even pause or unpause the process itself.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1Scheduler.html" title="Cooperative scheduler for processes. ">Scheduler</a></dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Derived</td><td>Actual type of process that extends the class template. </td></tr>
<tr><td class="paramname">Delta</td><td>Type to use to provide elapsed time. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00073">73</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae7a9c2acd493969267ce4a6d2e2884b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7a9c2acd493969267ce4a6d2e2884b8">&#9670;&nbsp;</a></span>abort()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::abort </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>immediately</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Aborts a process if it's still alive. </p>
<p>The function is idempotent and it does nothing if the process isn't alive.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">immediately</td><td>Requests an immediate operation. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00186">186</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="ad18ce3558d2325d622fb2b8ab51c49d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad18ce3558d2325d622fb2b8ab51c49d5">&#9670;&nbsp;</a></span>alive()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::alive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a process is either running or paused. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the process is still alive, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00200">200</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="a08265296592bcc0e5a6632b7067329b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08265296592bcc0e5a6632b7067329b9">&#9670;&nbsp;</a></span>dead()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::dead </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a process is already terminated. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the process is terminated, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00208">208</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="aa46a0784a199e1044c50e8aa34eea1bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa46a0784a199e1044c50e8aa34eea1bb">&#9670;&nbsp;</a></span>fail()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::fail </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates a process with errors if it's still alive. </p>
<p>The function is idempotent and it does nothing if the process isn't alive. </p>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00139">139</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="a1f2f865b2c4f0c7cf2d82786ecb50f5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f2f865b2c4f0c7cf2d82786ecb50f5f">&#9670;&nbsp;</a></span>pause()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::pause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops a process if it's in a running state. </p>
<p>The function is idempotent and it does nothing if the process isn't running. </p>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00151">151</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="a3e320da0927d9ac83dc829d0aee8a310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e320da0927d9ac83dc829d0aee8a310">&#9670;&nbsp;</a></span>paused()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::paused </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a process is currently paused. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the process is paused, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00216">216</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="aa4e618f12f5cf18d978557ea793b697d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4e618f12f5cf18d978557ea793b697d">&#9670;&nbsp;</a></span>rejected()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::rejected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a process terminated with errors. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the process terminated with errors, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00224">224</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="ae90a29bf2afabf6a14aec0e1d3809a0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90a29bf2afabf6a14aec0e1d3809a0f">&#9670;&nbsp;</a></span>succeed()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::succeed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates a process with success if it's still alive. </p>
<p>The function is idempotent and it does nothing if the process isn't alive. </p>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00127">127</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="a9298c55069b27d4ffa005f4345be4d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9298c55069b27d4ffa005f4345be4d59">&#9670;&nbsp;</a></span>tick()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::tick </td>
<td>(</td>
<td class="paramtype">const Delta&#160;</td>
<td class="paramname"><em>delta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates a process and its internal state if required. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delta</td><td>Elapsed time. </td></tr>
<tr><td class="paramname">data</td><td>Optional data. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00233">233</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<a id="aeb2057ef29594395ef68b965e6b27c7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb2057ef29594395ef68b965e6b27c7e">&#9670;&nbsp;</a></span>unpause()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>&lt; Derived, Delta &gt;::unpause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restarts a process if it's paused. </p>
<p>The function is idempotent and it does nothing if the process isn't paused. </p>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00163">163</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/entt/process/<a class="el" href="process_8hpp_source.html">process.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink