Skip to content

Commit

Permalink
update Orbbec API Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@zhonghong322 @jian-dong
zhonghong322 authored and jian-dong committed May 11, 2024
1 parent ed136f6 commit 58d12c5
Show file tree
Hide file tree
Showing 9 changed files with 3,346 additions and 0 deletions.
163 changes: 163 additions & 0 deletions doc/api/English/Context_8hpp_source.html
View file

Large diffs are not rendered by default.

447 changes: 447 additions & 0 deletions doc/api/English/Device_8hpp_source.html
View file

Large diffs are not rendered by default.

124 changes: 124 additions & 0 deletions doc/api/English/Error_8hpp_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Error.hpp 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="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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
<td id="projectalign">
<div id="projectname">OrbbecSDK<span id="projectnumber">&#160;1.10.5</span>
</div>
<div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8195f5c0d9a800b311ff87242d342361.html">libobsensor</a></li><li class="navelem"><a class="el" href="dir_551f50d4f6202563ca607f3aa0b67db1.html">hpp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Error.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="Error_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="Types_8hpp.html">Types.hpp</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">struct </span>ErrorImpl;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceob.html">ob</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classob_1_1Error.html"> 14</a></span><span class="keyword">class </span><a class="code hl_define" href="ObTypes_8h.html#aa0add2ff45ff52cc75dc92d44f883fbf">OB_EXTENSION_API</a> <a class="code hl_class" href="classob_1_1Error.html">Error</a> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> std::unique_ptr&lt;ErrorImpl&gt; impl_;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#ad57c7c1b50f263fc28de2a949f43164d"> 19</a></span> <a class="code hl_function" href="classob_1_1Error.html#ad57c7c1b50f263fc28de2a949f43164d">Error</a>(std::unique_ptr&lt;ErrorImpl&gt; impl) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#a7d5bcb83edc5be08ceed2e4e9ae5c5dc"> 21</a></span> <a class="code hl_function" href="classob_1_1Error.html#a7d5bcb83edc5be08ceed2e4e9ae5c5dc">Error</a>(<span class="keyword">const</span> <a class="code hl_class" href="classob_1_1Error.html">Error</a> &amp;error) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#ada72ad2b2eec48afff700debd8b33a52"> 23</a></span> <a class="code hl_function" href="classob_1_1Error.html#ada72ad2b2eec48afff700debd8b33a52">~Error</a>() noexcept;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#a3c2546bfe816ca7dd9cce0c78a8230d5"> 29</a></span> const <span class="keywordtype">char</span> *getMessage() const noexcept;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#acfa46889311fce0bbe56f46ec2d0dbb1"> 35</a></span> <a class="code hl_enumeration" href="ObTypes_8h.html#a63a34c60e68bddb4fd5fe26b54aaa7f3">OBExceptionType</a> getExceptionType() const noexcept;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#a31ce8b52e798f5ae8208c55acd4fc2fc"> 41</a></span> const <span class="keywordtype">char</span> *getName() const noexcept;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classob_1_1Error.html#a8382cb528f3ad5ebba2557fb86ed983b"> 47</a></span> const <span class="keywordtype">char</span> *getArgs() const noexcept;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>};</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>} <span class="comment">// namespace ob</span></div>
<div class="ttc" id="aObTypes_8h_html_a63a34c60e68bddb4fd5fe26b54aaa7f3"><div class="ttname"><a href="ObTypes_8h.html#a63a34c60e68bddb4fd5fe26b54aaa7f3">OBExceptionType</a></div><div class="ttdeci">OBExceptionType</div><div class="ttdoc">The exception types in the SDK, through the exception type, you can easily determine the specific typ...</div><div class="ttdef"><b>Definition</b> <a href="ObTypes_8h_source.html#l00129">ObTypes.h:129</a></div></div>
<div class="ttc" id="aObTypes_8h_html_aa0add2ff45ff52cc75dc92d44f883fbf"><div class="ttname"><a href="ObTypes_8h.html#aa0add2ff45ff52cc75dc92d44f883fbf">OB_EXTENSION_API</a></div><div class="ttdeci">#define OB_EXTENSION_API</div><div class="ttdef"><b>Definition</b> <a href="ObTypes_8h_source.html#l00028">ObTypes.h:28</a></div></div>
<div class="ttc" id="aTypes_8hpp_html"><div class="ttname"><a href="Types_8hpp.html">Types.hpp</a></div><div class="ttdoc">Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....</div></div>
<div class="ttc" id="aclassob_1_1Error_html"><div class="ttname"><a href="classob_1_1Error.html">ob::Error</a></div><div class="ttdef"><b>Definition</b> <a href="Error_8hpp_source.html#l00014">Error.hpp:14</a></div></div>
<div class="ttc" id="aclassob_1_1Error_html_a7d5bcb83edc5be08ceed2e4e9ae5c5dc"><div class="ttname"><a href="classob_1_1Error.html#a7d5bcb83edc5be08ceed2e4e9ae5c5dc">ob::Error::Error</a></div><div class="ttdeci">Error(const Error &amp;error) noexcept</div></div>
<div class="ttc" id="aclassob_1_1Error_html_ad57c7c1b50f263fc28de2a949f43164d"><div class="ttname"><a href="classob_1_1Error.html#ad57c7c1b50f263fc28de2a949f43164d">ob::Error::Error</a></div><div class="ttdeci">Error(std::unique_ptr&lt; ErrorImpl &gt; impl) noexcept</div></div>
<div class="ttc" id="aclassob_1_1Error_html_ada72ad2b2eec48afff700debd8b33a52"><div class="ttname"><a href="classob_1_1Error.html#ada72ad2b2eec48afff700debd8b33a52">ob::Error::~Error</a></div><div class="ttdeci">~Error() noexcept</div></div>
<div class="ttc" id="anamespaceob_html"><div class="ttname"><a href="namespaceob.html">ob</a></div><div class="ttdef"><b>Definition</b> <a href="Context_8hpp_source.html#l00016">Context.hpp:16</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
Loading

0 comments on commit 58d12c5

Please sign in to comment.