apalak/luna_mobile_online
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
luna_mobile_online/doc/fsdk/html/structfsdk_1_1_result.html
Apalak Dutta 1d8d8cd45e Initial commit
2023-05-12 10:25:25 +05:30

364 lines
19 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.5"/>
<title>Face Engine SDK: fsdk::Result&lt; E &gt; Struct 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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('structfsdk_1_1_result.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</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> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structfsdk_1_1_result-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fsdk::Result&lt; E &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A structure that encapsulates an action result enumeration.
<a href="structfsdk_1_1_result.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_result_8h_source.html">Result.h</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:a38653c59ecb8bfaa04caa5a77f4df3f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38653c59ecb8bfaa04caa5a77f4df3f0"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a38653c59ecb8bfaa04caa5a77f4df3f0">ErrorType</a> = E</td></tr>
<tr class="memdesc:a38653c59ecb8bfaa04caa5a77f4df3f0"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> value enumeration type. <br/></td></tr>
<tr class="separator:a38653c59ecb8bfaa04caa5a77f4df3f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2c5fe6ec18db9b9cb5507ad18490943"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2c5fe6ec18db9b9cb5507ad18490943"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>Traits</b> = <a class="el" href="structfsdk_1_1_error_traits.html">ErrorTraits</a>&lt; E &gt;</td></tr>
<tr class="separator:ac2c5fe6ec18db9b9cb5507ad18490943"><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:a06a734e30ac4eece206f4733b7a5d012"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a06a734e30ac4eece206f4733b7a5d012">Result</a> (E error) noexcept</td></tr>
<tr class="memdesc:a06a734e30ac4eece206f4733b7a5d012"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes result. <a href="#a06a734e30ac4eece206f4733b7a5d012">More...</a><br/></td></tr>
<tr class="separator:a06a734e30ac4eece206f4733b7a5d012"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3167e68bcb821500440dd076a6b42f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3167e68bcb821500440dd076a6b42f3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#aa3167e68bcb821500440dd076a6b42f3">Result</a> () noexcept</td></tr>
<tr class="memdesc:aa3167e68bcb821500440dd076a6b42f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes result by default. <br/></td></tr>
<tr class="separator:aa3167e68bcb821500440dd076a6b42f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75f966aa5f2402b66f000dacd18128f5"><td class="memItemLeft" align="right" valign="top">E&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a75f966aa5f2402b66f000dacd18128f5">getError</a> () const noexcept</td></tr>
<tr class="memdesc:a75f966aa5f2402b66f000dacd18128f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets actual result value. <a href="#a75f966aa5f2402b66f000dacd18128f5">More...</a><br/></td></tr>
<tr class="separator:a75f966aa5f2402b66f000dacd18128f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22fbfc59e9daa711b5f3d91a0976f5ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a22fbfc59e9daa711b5f3d91a0976f5ab">isError</a> () const noexcept</td></tr>
<tr class="memdesc:a22fbfc59e9daa711b5f3d91a0976f5ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for an error. <a href="#a22fbfc59e9daa711b5f3d91a0976f5ab">More...</a><br/></td></tr>
<tr class="separator:a22fbfc59e9daa711b5f3d91a0976f5ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea4380f5ed3f6c3e71ab70d0c0d422b0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#aea4380f5ed3f6c3e71ab70d0c0d422b0">isOk</a> () const noexcept</td></tr>
<tr class="memdesc:aea4380f5ed3f6c3e71ab70d0c0d422b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for a success. <a href="#aea4380f5ed3f6c3e71ab70d0c0d422b0">More...</a><br/></td></tr>
<tr class="separator:aea4380f5ed3f6c3e71ab70d0c0d422b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e12d3d63d36a0551279b15c0a8176ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a7e12d3d63d36a0551279b15c0a8176ac">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a7e12d3d63d36a0551279b15c0a8176ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for a success. <a href="#a7e12d3d63d36a0551279b15c0a8176ac">More...</a><br/></td></tr>
<tr class="separator:a7e12d3d63d36a0551279b15c0a8176ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41988070a3ccb7478b18f6c4fb4779f5"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a41988070a3ccb7478b18f6c4fb4779f5">what</a> () const noexcept</td></tr>
<tr class="memdesc:a41988070a3ccb7478b18f6c4fb4779f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a textual description of the result. <a href="#a41988070a3ccb7478b18f6c4fb4779f5">More...</a><br/></td></tr>
<tr class="separator:a41988070a3ccb7478b18f6c4fb4779f5"><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 E&gt;<br/>
struct fsdk::Result&lt; E &gt;</h3>
<p>A structure that encapsulates an action result enumeration. </p>
<p>An enum should specify a result code. By default the result is in a special uninitialized state which should be interpreted as an error. Default success value shoud be defined to zero. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">enumeration</td><td>to wrap. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a06a734e30ac4eece206f4733b7a5d012"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename E&gt; </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">fsdk::Result</a>&lt; E &gt;::<a class="el" href="structfsdk_1_1_result.html">Result</a> </td>
<td>(</td>
<td class="paramtype">E&#160;</td>
<td class="paramname"><em>error</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes result. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>value to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a75f966aa5f2402b66f000dacd18128f5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename E&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">E <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::getError </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets actual result value. </p>
<dl class="section return"><dt>Returns</dt><dd>actual result value. </dd></dl>
</div>
</div>
<a class="anchor" id="a22fbfc59e9daa711b5f3d91a0976f5ab"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename E&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::isError </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for an error. </p>
<dl class="section return"><dt>Returns</dt><dd>true if result represents an error. </dd></dl>
</div>
</div>
<a class="anchor" id="aea4380f5ed3f6c3e71ab70d0c0d422b0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename E&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::isOk </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for a success. </p>
<dl class="section return"><dt>Returns</dt><dd>true if result represents a success. </dd></dl>
</div>
</div>
<a class="anchor" id="a7e12d3d63d36a0551279b15c0a8176ac"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename E&gt; </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">fsdk::Result</a>&lt; E &gt;::operator bool </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks for a success. </p>
<dl class="section return"><dt>Returns</dt><dd>true if result represents a success. </dd></dl>
</div>
</div>
<a class="anchor" id="a41988070a3ccb7478b18f6c4fb4779f5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename E&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::what </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a textual description of the result. </p>
<dl class="section note"><dt>Note</dt><dd>function toString() should be specialized for this template type T. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>description string. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/fsdk/Types/<a class="el" href="_result_8h_source.html">Result.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="structfsdk_1_1_result.html">Result</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>
Reference in New Issue View Git Blame Copy Permalink