|
|
- <!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: include/fsdk/Types/Result.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
- <li class="current"><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="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>File 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('_result_8h_source.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="headertitle">
- <div class="title">Result.h</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <cstdint></span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="keyword">namespace </span>fsdk</div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> {</div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E></div>
- <div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="structfsdk_1_1_error_traits.html"> 9</a></span>  <span class="keyword">struct </span><a class="code" href="structfsdk_1_1_error_traits.html">ErrorTraits</a></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  {</div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> isOk(E) noexcept {</div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  }</div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* toString (E) noexcept {</div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keywordflow">return</span> <span class="stringliteral">"NOT AVAILABLE"</span>;</div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  }</div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  };</div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E></div>
- <div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html"> 29</a></span>  <span class="keyword">struct </span><a class="code" href="structfsdk_1_1_result.html">Result</a></div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  {</div>
- <div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#a38653c59ecb8bfaa04caa5a77f4df3f0"> 32</a></span>  <span class="keyword">using</span> <a class="code" href="structfsdk_1_1_result.html#a38653c59ecb8bfaa04caa5a77f4df3f0">ErrorType</a> = E;</div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">using</span> <a class="code" href="structfsdk_1_1_error_traits.html">Traits</a> = <a class="code" href="structfsdk_1_1_error_traits.html">ErrorTraits<E></a>;</div>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
- <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#a06a734e30ac4eece206f4733b7a5d012"> 38</a></span>  <span class="keyword">explicit</span> <a class="code" href="structfsdk_1_1_result.html#a06a734e30ac4eece206f4733b7a5d012">Result</a>(E error) noexcept</div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  : m_error(error) {}</div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
- <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#aa3167e68bcb821500440dd076a6b42f3"> 43</a></span>  <a class="code" href="structfsdk_1_1_result.html#aa3167e68bcb821500440dd076a6b42f3">Result</a>() noexcept</div>
- <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  : m_error(E::<a class="code" href="namespacefsdk.html#a811cc08198c8cb908dc856217ef6c4f6aa60852f204ed8028c1c58808b746d115">Ok</a>) {}</div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
- <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#a75f966aa5f2402b66f000dacd18128f5"> 49</a></span>  E <a class="code" href="structfsdk_1_1_result.html#a75f966aa5f2402b66f000dacd18128f5">getError</a>() const noexcept {</div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> m_error;</div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
- <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#a22fbfc59e9daa711b5f3d91a0976f5ab"> 56</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structfsdk_1_1_result.html#a22fbfc59e9daa711b5f3d91a0976f5ab">isError</a>() const noexcept {</div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">return</span> !<a class="code" href="structfsdk_1_1_result.html#aea4380f5ed3f6c3e71ab70d0c0d422b0">isOk</a>();</div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
- <div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#aea4380f5ed3f6c3e71ab70d0c0d422b0"> 63</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structfsdk_1_1_result.html#aea4380f5ed3f6c3e71ab70d0c0d422b0">isOk</a>() const noexcept {</div>
- <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> Traits::isOk(m_error);</div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
- <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#a7e12d3d63d36a0551279b15c0a8176ac"> 70</a></span>  <span class="keyword">operator</span> bool () const noexcept {</div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> <a class="code" href="structfsdk_1_1_result.html#aea4380f5ed3f6c3e71ab70d0c0d422b0">isOk</a>();</div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
- <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structfsdk_1_1_result.html#a41988070a3ccb7478b18f6c4fb4779f5"> 79</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structfsdk_1_1_result.html#a41988070a3ccb7478b18f6c4fb4779f5">what</a>() const noexcept {</div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> Traits::toString(<a class="code" href="structfsdk_1_1_result.html#a75f966aa5f2402b66f000dacd18128f5">getError</a>());</div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">private</span>:</div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  E m_error; </div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  };</div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E></div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">inline</span> Result<E> makeResult(E error) noexcept {</div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> Result<E>(error);</div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> }</div>
- <div class="ttc" id="structfsdk_1_1_result_html"><div class="ttname"><a href="structfsdk_1_1_result.html">fsdk::Result</a></div><div class="ttdoc">A structure that encapsulates an action result enumeration. </div><div class="ttdef"><b>Definition:</b> Result.h:29</div></div>
- <div class="ttc" id="structfsdk_1_1_error_traits_html"><div class="ttname"><a href="structfsdk_1_1_error_traits.html">fsdk::ErrorTraits</a></div><div class="ttdef"><b>Definition:</b> Result.h:9</div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_a41988070a3ccb7478b18f6c4fb4779f5"><div class="ttname"><a href="structfsdk_1_1_result.html#a41988070a3ccb7478b18f6c4fb4779f5">fsdk::Result::what</a></div><div class="ttdeci">const char * what() const noexcept</div><div class="ttdoc">Gets a textual description of the result. </div><div class="ttdef"><b>Definition:</b> Result.h:79</div></div>
- <div class="ttc" id="namespacefsdk_html_a811cc08198c8cb908dc856217ef6c4f6aa60852f204ed8028c1c58808b746d115"><div class="ttname"><a href="namespacefsdk.html#a811cc08198c8cb908dc856217ef6c4f6aa60852f204ed8028c1c58808b746d115">fsdk::FSDKError::Ok</a></div><div class="ttdoc">Ok. </div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_a06a734e30ac4eece206f4733b7a5d012"><div class="ttname"><a href="structfsdk_1_1_result.html#a06a734e30ac4eece206f4733b7a5d012">fsdk::Result::Result</a></div><div class="ttdeci">Result(E error) noexcept</div><div class="ttdoc">Initializes result. </div><div class="ttdef"><b>Definition:</b> Result.h:38</div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_a75f966aa5f2402b66f000dacd18128f5"><div class="ttname"><a href="structfsdk_1_1_result.html#a75f966aa5f2402b66f000dacd18128f5">fsdk::Result::getError</a></div><div class="ttdeci">E getError() const noexcept</div><div class="ttdoc">Gets actual result value. </div><div class="ttdef"><b>Definition:</b> Result.h:49</div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_a22fbfc59e9daa711b5f3d91a0976f5ab"><div class="ttname"><a href="structfsdk_1_1_result.html#a22fbfc59e9daa711b5f3d91a0976f5ab">fsdk::Result::isError</a></div><div class="ttdeci">bool isError() const noexcept</div><div class="ttdoc">Checks for an error. </div><div class="ttdef"><b>Definition:</b> Result.h:56</div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_aa3167e68bcb821500440dd076a6b42f3"><div class="ttname"><a href="structfsdk_1_1_result.html#aa3167e68bcb821500440dd076a6b42f3">fsdk::Result::Result</a></div><div class="ttdeci">Result() noexcept</div><div class="ttdoc">Initializes result by default. </div><div class="ttdef"><b>Definition:</b> Result.h:43</div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_a38653c59ecb8bfaa04caa5a77f4df3f0"><div class="ttname"><a href="structfsdk_1_1_result.html#a38653c59ecb8bfaa04caa5a77f4df3f0">fsdk::Result< R >::ErrorType</a></div><div class="ttdeci">R ErrorType</div><div class="ttdoc">Result value enumeration type. </div><div class="ttdef"><b>Definition:</b> Result.h:32</div></div>
- <div class="ttc" id="structfsdk_1_1_result_html_aea4380f5ed3f6c3e71ab70d0c0d422b0"><div class="ttname"><a href="structfsdk_1_1_result.html#aea4380f5ed3f6c3e71ab70d0c0d422b0">fsdk::Result::isOk</a></div><div class="ttdeci">bool isOk() const noexcept</div><div class="ttdoc">Checks for a success. </div><div class="ttdef"><b>Definition:</b> Result.h:63</div></div>
- </div><!-- fragment --></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f55a93227fda83d5dd4a3d796702467d.html">fsdk</a></li><li class="navelem"><a class="el" href="dir_104afe3ef84f31716f380b8a9fe62f28.html">Types</a></li><li class="navelem"><b>Result.h</b></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>
|
