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.

363 lines
19 KiB

1 year ago
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.5"/>
  7. <title>Face Engine SDK: fsdk::Result&lt; E &gt; Struct Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. $(window).load(resizeHeight);
  17. </script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/search.js"></script>
  20. <script type="text/javascript">
  21. $(document).ready(function() { searchBox.OnSelectItem(0); });
  22. </script>
  23. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  24. </head>
  25. <body>
  26. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  27. <div id="titlearea">
  28. <table cellspacing="0" cellpadding="0">
  29. <tbody>
  30. <tr style="height: 56px;">
  31. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  32. <td style="padding-left: 0.5em;">
  33. <div id="projectname">Face Engine SDK
  34. &#160;<span id="projectnumber">5.8.0</span>
  35. </div>
  36. <div id="projectbrief">A face detection, recognition and tracking engine.</div>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.8.5 -->
  44. <script type="text/javascript">
  45. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  46. </script>
  47. <div id="navrow1" class="tabs">
  48. <ul class="tablist">
  49. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  50. <li><a href="modules.html"><span>Modules</span></a></li>
  51. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  52. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  53. <li><a href="files.html"><span>Files</span></a></li>
  54. <li>
  55. <div id="MSearchBox" class="MSearchBoxInactive">
  56. <span class="left">
  57. <img id="MSearchSelect" src="search/mag_sel.png"
  58. onmouseover="return searchBox.OnSearchSelectShow()"
  59. onmouseout="return searchBox.OnSearchSelectHide()"
  60. alt=""/>
  61. <input type="text" id="MSearchField" value="Search" accesskey="S"
  62. onfocus="searchBox.OnSearchFieldFocus(true)"
  63. onblur="searchBox.OnSearchFieldFocus(false)"
  64. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  65. </span><span class="right">
  66. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  67. </span>
  68. </div>
  69. </li>
  70. </ul>
  71. </div>
  72. <div id="navrow2" class="tabs2">
  73. <ul class="tablist">
  74. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  75. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  76. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  77. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('structfsdk_1_1_result.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#pub-types">Public Types</a> &#124;
  110. <a href="#pub-methods">Public Member Functions</a> &#124;
  111. <a href="structfsdk_1_1_result-members.html">List of all members</a> </div>
  112. <div class="headertitle">
  113. <div class="title">fsdk::Result&lt; E &gt; Struct Template Reference</div> </div>
  114. </div><!--header-->
  115. <div class="contents">
  116. <p>A structure that encapsulates an action result enumeration.
  117. <a href="structfsdk_1_1_result.html#details">More...</a></p>
  118. <p><code>#include &lt;<a class="el" href="_result_8h_source.html">Result.h</a>&gt;</code></p>
  119. <table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  121. Public Types</h2></td></tr>
  122. <tr class="memitem:a38653c59ecb8bfaa04caa5a77f4df3f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38653c59ecb8bfaa04caa5a77f4df3f0"></a>
  123. using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#a38653c59ecb8bfaa04caa5a77f4df3f0">ErrorType</a> = E</td></tr>
  124. <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>
  125. <tr class="separator:a38653c59ecb8bfaa04caa5a77f4df3f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ac2c5fe6ec18db9b9cb5507ad18490943"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2c5fe6ec18db9b9cb5507ad18490943"></a>
  127. 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>
  128. <tr class="separator:ac2c5fe6ec18db9b9cb5507ad18490943"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table><table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  131. Public Member Functions</h2></td></tr>
  132. <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>
  133. <tr class="memdesc:a06a734e30ac4eece206f4733b7a5d012"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes result. <a href="#a06a734e30ac4eece206f4733b7a5d012">More...</a><br/></td></tr>
  134. <tr class="separator:a06a734e30ac4eece206f4733b7a5d012"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aa3167e68bcb821500440dd076a6b42f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3167e68bcb821500440dd076a6b42f3"></a>
  136. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_result.html#aa3167e68bcb821500440dd076a6b42f3">Result</a> () noexcept</td></tr>
  137. <tr class="memdesc:aa3167e68bcb821500440dd076a6b42f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes result by default. <br/></td></tr>
  138. <tr class="separator:aa3167e68bcb821500440dd076a6b42f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="memdesc:a75f966aa5f2402b66f000dacd18128f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets actual result value. <a href="#a75f966aa5f2402b66f000dacd18128f5">More...</a><br/></td></tr>
  141. <tr class="separator:a75f966aa5f2402b66f000dacd18128f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="memdesc:a22fbfc59e9daa711b5f3d91a0976f5ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for an error. <a href="#a22fbfc59e9daa711b5f3d91a0976f5ab">More...</a><br/></td></tr>
  144. <tr class="separator:a22fbfc59e9daa711b5f3d91a0976f5ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="memdesc:aea4380f5ed3f6c3e71ab70d0c0d422b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for a success. <a href="#aea4380f5ed3f6c3e71ab70d0c0d422b0">More...</a><br/></td></tr>
  147. <tr class="separator:aea4380f5ed3f6c3e71ab70d0c0d422b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="memdesc:a7e12d3d63d36a0551279b15c0a8176ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for a success. <a href="#a7e12d3d63d36a0551279b15c0a8176ac">More...</a><br/></td></tr>
  150. <tr class="separator:a7e12d3d63d36a0551279b15c0a8176ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <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>
  153. <tr class="separator:a41988070a3ccb7478b18f6c4fb4779f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table>
  155. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  156. <div class="textblock"><h3>template&lt;typename E&gt;<br/>
  157. struct fsdk::Result&lt; E &gt;</h3>
  158. <p>A structure that encapsulates an action result enumeration. </p>
  159. <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>
  160. <dl class="tparams"><dt>Template Parameters</dt><dd>
  161. <table class="tparams">
  162. <tr><td class="paramname">enumeration</td><td>to wrap. </td></tr>
  163. </table>
  164. </dd>
  165. </dl>
  166. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  167. <a class="anchor" id="a06a734e30ac4eece206f4733b7a5d012"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <div class="memtemplate">
  171. template&lt;typename E&gt; </div>
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <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>
  178. <td>(</td>
  179. <td class="paramtype">E&#160;</td>
  180. <td class="paramname"><em>error</em></td><td>)</td>
  181. <td></td>
  182. </tr>
  183. </table>
  184. </td>
  185. <td class="mlabels-right">
  186. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Initializes result. </p>
  191. <dl class="params"><dt>Parameters</dt><dd>
  192. <table class="params">
  193. <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>value to set. </td></tr>
  194. </table>
  195. </dd>
  196. </dl>
  197. </div>
  198. </div>
  199. <h2 class="groupheader">Member Function Documentation</h2>
  200. <a class="anchor" id="a75f966aa5f2402b66f000dacd18128f5"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <div class="memtemplate">
  204. template&lt;typename E&gt; </div>
  205. <table class="mlabels">
  206. <tr>
  207. <td class="mlabels-left">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">E <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::getError </td>
  211. <td>(</td>
  212. <td class="paramname"></td><td>)</td>
  213. <td> const</td>
  214. </tr>
  215. </table>
  216. </td>
  217. <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Gets actual result value. </p>
  223. <dl class="section return"><dt>Returns</dt><dd>actual result value. </dd></dl>
  224. </div>
  225. </div>
  226. <a class="anchor" id="a22fbfc59e9daa711b5f3d91a0976f5ab"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <div class="memtemplate">
  230. template&lt;typename E&gt; </div>
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">bool <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::isError </td>
  237. <td>(</td>
  238. <td class="paramname"></td><td>)</td>
  239. <td> const</td>
  240. </tr>
  241. </table>
  242. </td>
  243. <td class="mlabels-right">
  244. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Checks for an error. </p>
  249. <dl class="section return"><dt>Returns</dt><dd>true if result represents an error. </dd></dl>
  250. </div>
  251. </div>
  252. <a class="anchor" id="aea4380f5ed3f6c3e71ab70d0c0d422b0"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <div class="memtemplate">
  256. template&lt;typename E&gt; </div>
  257. <table class="mlabels">
  258. <tr>
  259. <td class="mlabels-left">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">bool <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::isOk </td>
  263. <td>(</td>
  264. <td class="paramname"></td><td>)</td>
  265. <td> const</td>
  266. </tr>
  267. </table>
  268. </td>
  269. <td class="mlabels-right">
  270. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Checks for a success. </p>
  275. <dl class="section return"><dt>Returns</dt><dd>true if result represents a success. </dd></dl>
  276. </div>
  277. </div>
  278. <a class="anchor" id="a7e12d3d63d36a0551279b15c0a8176ac"></a>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <div class="memtemplate">
  282. template&lt;typename E&gt; </div>
  283. <table class="mlabels">
  284. <tr>
  285. <td class="mlabels-left">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname"><a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::operator bool </td>
  289. <td>(</td>
  290. <td class="paramname"></td><td>)</td>
  291. <td> const</td>
  292. </tr>
  293. </table>
  294. </td>
  295. <td class="mlabels-right">
  296. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Checks for a success. </p>
  301. <dl class="section return"><dt>Returns</dt><dd>true if result represents a success. </dd></dl>
  302. </div>
  303. </div>
  304. <a class="anchor" id="a41988070a3ccb7478b18f6c4fb4779f5"></a>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <div class="memtemplate">
  308. template&lt;typename E&gt; </div>
  309. <table class="mlabels">
  310. <tr>
  311. <td class="mlabels-left">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">const char* <a class="el" href="structfsdk_1_1_result.html">fsdk::Result</a>&lt; E &gt;::what </td>
  315. <td>(</td>
  316. <td class="paramname"></td><td>)</td>
  317. <td> const</td>
  318. </tr>
  319. </table>
  320. </td>
  321. <td class="mlabels-right">
  322. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p>Gets a textual description of the result. </p>
  327. <dl class="section note"><dt>Note</dt><dd>function toString() should be specialized for this template type T. </dd></dl>
  328. <dl class="section return"><dt>Returns</dt><dd>description string. </dd></dl>
  329. </div>
  330. </div>
  331. <hr/>The documentation for this struct was generated from the following file:<ul>
  332. <li>include/fsdk/Types/<a class="el" href="_result_8h_source.html">Result.h</a></li>
  333. </ul>
  334. </div><!-- contents -->
  335. </div><!-- doc-content -->
  336. <!-- start footer part -->
  337. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  338. <ul>
  339. <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>
  340. <li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
  341. <a href="http://www.doxygen.org/index.html">
  342. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
  343. </ul>
  344. </div>
  345. </body>
  346. </html>