Skip to content

Commit

Permalink
Update documentation to df23b89
Browse files Browse the repository at this point in the history
  • Loading branch information
@dNechita @cseci
dNechita authored and cseci committed Feb 12, 2024
0 parents commit 997d10c
Show file tree
Hide file tree
Showing 356 changed files with 18,076 additions and 0 deletions.
95 changes: 95 additions & 0 deletions annotated.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<!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">
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Time-of-Flight-SDK: Class List</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Time-of-Flight-SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceaditof.html" target="_self">aditof</a></td><td class="desc">Namespace aditof </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaditof_1_1_buffer_info.html" target="_self">BufferInfo</a></td><td class="desc">Provides extra details for the frame buffer </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_camera.html" target="_self">Camera</a></td><td class="desc">Manipulates the underlying camera system </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaditof_1_1_camera_details.html" target="_self">CameraDetails</a></td><td class="desc">Describes the properties of a camera </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaditof_1_1_depth_parameters.html" target="_self">DepthParameters</a></td><td class="desc">Describes the depth parameters of a camera </td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_depth_sensor_interface.html" target="_self">DepthSensorInterface</a></td><td class="desc">Provides access to the low level functionality of the camera sensor. This includes sensor configuration as well as analog front end(AFE) configuration </td></tr>
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_frame.html" target="_self">Frame</a></td><td class="desc"><a class="el" href="classaditof_1_1_frame.html" title="Frame of a camera.">Frame</a> of a camera </td></tr>
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaditof_1_1_frame_details.html" target="_self">FrameDetails</a></td><td class="desc">Describes the properties of a frame </td></tr>
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaditof_1_1_intrinsic_parameters.html" target="_self">IntrinsicParameters</a></td><td class="desc">Describes the intrinsic parameters of a camera </td></tr>
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaditof_1_1_sensor_details.html" target="_self">SensorDetails</a></td><td class="desc">Provides details about the device </td></tr>
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_sensor_enumerator_factory.html" target="_self">SensorEnumeratorFactory</a></td><td class="desc">Provides the means to construct different types of sensors enumerators. Based on the connection type (on target, USB, Network), different enumerators need to be used </td></tr>
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_sensor_enumerator_interface.html" target="_self">SensorEnumeratorInterface</a></td><td class="desc">Can search for sensors and retrieve sensors by category </td></tr>
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_storage_interface.html" target="_self">StorageInterface</a></td><td class="desc">Interface for storage of data. For example: EEPROM, Flash, file on disk, etc </td></tr>
<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_system.html" target="_self">System</a></td><td class="desc">The TOF system that manages the cameras </td></tr>
<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaditof_1_1_temperature_sensor_interface.html" target="_self">TemperatureSensorInterface</a></td><td class="desc">Interface for a temperature sensor </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
Binary file added bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 86 additions & 0 deletions camera_8h_source.html

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions camera__definitions_8h_source.html

Large diffs are not rendered by default.

99 changes: 99 additions & 0 deletions classaditof_1_1_camera-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<!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">
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Time-of-Flight-SDK: Member List</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Time-of-Flight-SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceaditof.html">aditof</a></li><li class="navelem"><a class="el" href="classaditof_1_1_camera.html">Camera</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">aditof::Camera Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a682c7e8b7f37010e94c8d53475721865">getAvailableControls</a>(std::vector&lt; std::string &gt; &amp;controls) const =0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a84cb2d8764a1973364275c709b224b87">getAvailableFrameTypes</a>(std::vector&lt; std::string &gt; &amp;availableFrameTypes) const =0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#aa61cba3363b54485494762222cf1d45e">getAvailableModes</a>(std::vector&lt; std::string &gt; &amp;availableModes) const =0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a14bc023a5a70fc0509b2356a94c37caf">getControl</a>(const std::string &amp;control, std::string &amp;value) const =0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a32f30de6c2b380902088e144b78d668e">getDetails</a>(CameraDetails &amp;details) const =0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#aa5698c09e86bf01fceebe9691a4f44e7">getEeproms</a>(std::vector&lt; std::shared_ptr&lt; StorageInterface &gt;&gt; &amp;eeproms)=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#ae1bad2fee84af5f9095f7503f118b496">getImageSensors</a>(std::vector&lt; std::shared_ptr&lt; DepthSensorInterface &gt;&gt; &amp;sensors)=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#aa1210633314f8baa755ac6ff4cd1deae">getTemperatureSensors</a>(std::vector&lt; std::shared_ptr&lt; TemperatureSensorInterface &gt;&gt; &amp;sensors)=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a016796dfeb7529dce15d44bcbbaaaab3">initialize</a>()=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#aa65ff6a81224f44f6d7525d24da7fdec">requestFrame</a>(Frame *frame, FrameUpdateCallback cb=nullptr)=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a0edd7d603b54228eb842586c5f488721">setControl</a>(const std::string &amp;control, const std::string &amp;value)=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#ab2961da3814b129e3d44820c311d3479">setFrameType</a>(const std::string &amp;frameType)=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a9919bc0b2ae51212eab477d7052c1206">setMode</a>(const std::string &amp;mode, const std::string &amp;modeFilename={})=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a892415d70d62e2d9a8501479ec89a762">start</a>()=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a0de7b55a7c12e0947dfc444ada851471">stop</a>()=0</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaditof_1_1_camera.html#a659d5a32440b643aa9d6b4a191173a0e">~Camera</a>()=default</td><td class="entry"><a class="el" href="classaditof_1_1_camera.html">aditof::Camera</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
Loading

0 comments on commit 997d10c

Please sign in to comment.