You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
378 lines
25 KiB
378 lines
25 KiB
<!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.5"/>
|
|
<title>Face Engine SDK: fsdk::Future< T > 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Face Engine SDK
|
|
 <span id="projectnumber">5.8.0</span>
|
|
</div>
|
|
<div id="projectbrief">A face detection, recognition and tracking engine.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('classfsdk_1_1_future.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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 class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classfsdk_1_1_future-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fsdk::Future< T > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classfsdk_1_1_future.html" title="Future class to support asynchronous data retrieval Look into std::future semantics to understand it...">Future</a> class to support asynchronous data retrieval Look into std::future semantics to understand it.
|
|
<a href="classfsdk_1_1_future.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_future_8h_source.html">Future.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for fsdk::Future< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classfsdk_1_1_future.png" usemap="#fsdk::Future< T >_map" alt=""/>
|
|
<map id="fsdk::Future< T >_map" name="fsdk::Future< T >_map">
|
|
<area href="classfsdk_1_1_noncopyable.html" title="Helper class to block copy operator&constructor of its descendants. " alt="fsdk::Noncopyable" shape="rect" coords="0,0,116,24"/>
|
|
</map>
|
|
</div></div>
|
|
<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:ab792dd0d1b8eac18d3a0d875d215575f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab792dd0d1b8eac18d3a0d875d215575f"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#ab792dd0d1b8eac18d3a0d875d215575f">USec</a> = int32_t</td></tr>
|
|
<tr class="memdesc:ab792dd0d1b8eac18d3a0d875d215575f"><td class="mdescLeft"> </td><td class="mdescRight">Alias for micro seconds type. <br/></td></tr>
|
|
<tr class="separator:ab792dd0d1b8eac18d3a0d875d215575f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a5efae2498601862b9514b6d58661c6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a5efae2498601862b9514b6d58661c6"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6">Error</a> = <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">FutureError</a></td></tr>
|
|
<tr class="memdesc:a9a5efae2498601862b9514b6d58661c6"><td class="mdescLeft"> </td><td class="mdescRight">Alias for associated error type. <br/></td></tr>
|
|
<tr class="separator:a9a5efae2498601862b9514b6d58661c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38f572195de92595cbc6c847fb7470ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38f572195de92595cbc6c847fb7470ec"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a38f572195de92595cbc6c847fb7470ec">DataType</a> = T</td></tr>
|
|
<tr class="memdesc:a38f572195de92595cbc6c847fb7470ec"><td class="mdescLeft"> </td><td class="mdescRight">Alias for stored data type. <br/></td></tr>
|
|
<tr class="separator:a38f572195de92595cbc6c847fb7470ec"><td class="memSeparator" colspan="2"> </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:a88569ef592c8f9793067cb1139123aaf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88569ef592c8f9793067cb1139123aaf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a88569ef592c8f9793067cb1139123aaf">Future</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a88569ef592c8f9793067cb1139123aaf"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for empty useless shell of a future. <br/></td></tr>
|
|
<tr class="separator:a88569ef592c8f9793067cb1139123aaf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad456b58442c956f349975302ebf9c8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad456b58442c956f349975302ebf9c8e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Future</b> (<a class="el" href="classfsdk_1_1_future.html">Future</a> &&mv) noexcept</td></tr>
|
|
<tr class="separator:aad456b58442c956f349975302ebf9c8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a942829f2284cae1feebbdeae05e9041d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a942829f2284cae1feebbdeae05e9041d"></a>
|
|
<a class="el" href="classfsdk_1_1_future.html">Future</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfsdk_1_1_future.html">Future</a> &&) noexcept</td></tr>
|
|
<tr class="separator:a942829f2284cae1feebbdeae05e9041d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaaed4d6e1ad65c21ac4ac4e547e93f53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#aaaed4d6e1ad65c21ac4ac4e547e93f53">cancel</a> (const <a class="el" href="namespacefsdk.html#a0f4cbbc8c61f0127bd75695e76869860">ExecutionPolicy</a> policy) noexcept</td></tr>
|
|
<tr class="memdesc:aaaed4d6e1ad65c21ac4ac4e547e93f53"><td class="mdescLeft"> </td><td class="mdescRight">Cancel method. Might be called on some heavy long running task that is not needed anymore. Only makes sense if underlying state is Promised. <a href="#aaaed4d6e1ad65c21ac4ac4e547e93f53">More...</a><br/></td></tr>
|
|
<tr class="separator:aaaed4d6e1ad65c21ac4ac4e547e93f53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b52e6264dc9fb54d143712efdb783b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a2b52e6264dc9fb54d143712efdb783b8">state</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a2b52e6264dc9fb54d143712efdb783b8"><td class="mdescLeft"> </td><td class="mdescRight">Returns current state of future-promise pair. <a href="#a2b52e6264dc9fb54d143712efdb783b8">More...</a><br/></td></tr>
|
|
<tr class="separator:a2b52e6264dc9fb54d143712efdb783b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac30c21fa31a1d66e732bfffada32e03a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#ac30c21fa31a1d66e732bfffada32e03a">takeInto</a> (<a class="el" href="classfsdk_1_1_future.html#a38f572195de92595cbc6c847fb7470ec">DataType</a> &container) noexcept</td></tr>
|
|
<tr class="memdesc:ac30c21fa31a1d66e732bfffada32e03a"><td class="mdescLeft"> </td><td class="mdescRight">Method to retrieve data out of fulfilled future. Only makes sense if current state is Fulfilled. <a href="#ac30c21fa31a1d66e732bfffada32e03a">More...</a><br/></td></tr>
|
|
<tr class="separator:ac30c21fa31a1d66e732bfffada32e03a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e85628150597362aad032ea8029dcf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a7e85628150597362aad032ea8029dcf9">wait</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a7e85628150597362aad032ea8029dcf9"><td class="mdescLeft"> </td><td class="mdescRight">Blocks called thread until internal state changes to Fulfilled, Canceled or Failed. <a href="#a7e85628150597362aad032ea8029dcf9">More...</a><br/></td></tr>
|
|
<tr class="separator:a7e85628150597362aad032ea8029dcf9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1da1098643943411046bbe6a718fe74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#ab1da1098643943411046bbe6a718fe74">waitFor</a> (const <a class="el" href="classfsdk_1_1_future.html#ab792dd0d1b8eac18d3a0d875d215575f">USec</a> usec) const noexcept</td></tr>
|
|
<tr class="memdesc:ab1da1098643943411046bbe6a718fe74"><td class="mdescLeft"> </td><td class="mdescRight">Blocks called thread until internal state changes to Fulfilled, Canceled or Failed, OR passed time is over. <a href="#ab1da1098643943411046bbe6a718fe74">More...</a><br/></td></tr>
|
|
<tr class="separator:ab1da1098643943411046bbe6a718fe74"><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:a7f7977f3ac4805fda79869a23f9f8686"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f7977f3ac4805fda79869a23f9f8686"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a7f7977f3ac4805fda79869a23f9f8686">swap</a> (<a class="el" href="classfsdk_1_1_future.html">Future</a> &first, <a class="el" href="classfsdk_1_1_future.html">Future</a> &second) noexcept</td></tr>
|
|
<tr class="memdesc:a7f7977f3ac4805fda79869a23f9f8686"><td class="mdescLeft"> </td><td class="mdescRight">Static method that swaps internal data between two passed futures. <br/></td></tr>
|
|
<tr class="separator:a7f7977f3ac4805fda79869a23f9f8686"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename T><br/>
|
|
class fsdk::Future< T ></h3>
|
|
|
|
<p><a class="el" href="classfsdk_1_1_future.html" title="Future class to support asynchronous data retrieval Look into std::future semantics to understand it...">Future</a> class to support asynchronous data retrieval Look into std::future semantics to understand it. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Is not instantiable using this header only. </dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>data type to store. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aaaed4d6e1ad65c21ac4ac4e547e93f53"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>> <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>< T >::cancel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacefsdk.html#a0f4cbbc8c61f0127bd75695e76869860">ExecutionPolicy</a> </td>
|
|
<td class="paramname"><em>policy</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Cancel method. Might be called on some heavy long running task that is not needed anymore. Only makes sense if underlying state is Promised. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">policy</td><td>Policy on how to behave: block till state becomes Canceled or run async. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2b52e6264dc9fb54d143712efdb783b8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a> <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>< T >::state </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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns current state of future-promise pair. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current state </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b" title="Enumeration of possible future or promise states. ">FuturePromiseState</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac30c21fa31a1d66e732bfffada32e03a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>> <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>< T >::takeInto </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classfsdk_1_1_future.html#a38f572195de92595cbc6c847fb7470ec">DataType</a> & </td>
|
|
<td class="paramname"><em>container</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to retrieve data out of fulfilled future. Only makes sense if current state is Fulfilled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">container</td><td>Reference to DataType object to fill with future' data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7e85628150597362aad032ea8029dcf9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>> <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>< T >::wait </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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocks called thread until internal state changes to Fulfilled, Canceled or Failed. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab1da1098643943411046bbe6a718fe74"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>> <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>< T >::waitFor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classfsdk_1_1_future.html#ab792dd0d1b8eac18d3a0d875d215575f">USec</a> </td>
|
|
<td class="paramname"><em>usec</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocks called thread until internal state changes to Fulfilled, Canceled or Failed, OR passed time is over. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">usec</td><td>Upper bound of microseconds to wait. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/fsdk/Types/<a class="el" href="_future_8h_source.html">Future.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacefsdk.html">fsdk</a></li><li class="navelem"><a class="el" href="classfsdk_1_1_future.html">Future</a></li>
|
|
<li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|