This repository has been archived on 2026-02-22. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
Livox-SDK/docs/namespacelivox.html
2020-04-01 20:53:55 +08:00

323 lines
17 KiB
HTML

<!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.11"/>
<title>Livox SDK API: livox Namespace 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="navtreedata.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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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="1.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Livox SDK API
&#160;<span id="projectnumber">V2.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#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('namespacelivox.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)">
</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="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">livox Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html">CommPort</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlivox_1_1_port_cache.html">PortCache</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html">Protocol</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af4e436d907dcafb14fcc88a760f75090"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#af4e436d907dcafb14fcc88a760f75090">CommPacket</a></td></tr>
<tr class="separator:af4e436d907dcafb14fcc88a760f75090"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7370a98d65fd20693ed58a470ec9439"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#ad7370a98d65fd20693ed58a470ec9439">RequestPackCb</a>) (<a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> *packet)</td></tr>
<tr class="separator:ad7370a98d65fd20693ed58a470ec9439"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6941cc71243dd1b067c904fdd91bfb61"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#a6941cc71243dd1b067c904fdd91bfb61">PacketType</a> { <a class="el" href="namespacelivox.html#a6941cc71243dd1b067c904fdd91bfb61aac306c9b5938dac53c45dfc4fcc9c132">kRequestPack</a>,
<a class="el" href="namespacelivox.html#a6941cc71243dd1b067c904fdd91bfb61a9686d537f806d748aece1f03b523d50e">kAckPack</a>,
<a class="el" href="namespacelivox.html#a6941cc71243dd1b067c904fdd91bfb61a195c6286a980061276877c88f4347a65">kMsgPack</a>
}</td></tr>
<tr class="separator:a6941cc71243dd1b067c904fdd91bfb61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab97b5b082d8b27d02cd14daeb8c9807c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#ab97b5b082d8b27d02cd14daeb8c9807c">ProtocolType</a> { <a class="el" href="namespacelivox.html#ab97b5b082d8b27d02cd14daeb8c9807caa1131d8950d9c7527cafd32ececda15d">kLidarSdk</a>,
<a class="el" href="namespacelivox.html#ab97b5b082d8b27d02cd14daeb8c9807ca74908aea2df12e49a212f0b00bae1b25">kRsvd1</a>,
<a class="el" href="namespacelivox.html#ab97b5b082d8b27d02cd14daeb8c9807ca892dd3366a89802324e48987b8cb34e1">kProtocolUndef</a>
}</td></tr>
<tr class="separator:ab97b5b082d8b27d02cd14daeb8c9807c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afeebe28eda25022afdc079c1aaff209c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#afeebe28eda25022afdc079c1aaff209c">NeedAckType</a> { <a class="el" href="namespacelivox.html#afeebe28eda25022afdc079c1aaff209ca04b4a83f4d5f6af89e52b2d9cfadbb24">kNoNeed</a>,
<a class="el" href="namespacelivox.html#afeebe28eda25022afdc079c1aaff209ca0bfce7eeeb94e9fa66f051de4e0f8889">kNeedAck</a>,
<a class="el" href="namespacelivox.html#afeebe28eda25022afdc079c1aaff209caa59408252d4020dffb9cd35aa5917337">kDelayAck</a>
}</td></tr>
<tr class="separator:afeebe28eda25022afdc079c1aaff209c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0c7b20b2866108c5e232ff70bea4820"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#aa0c7b20b2866108c5e232ff70bea4820">ParseResult</a> { <a class="el" href="namespacelivox.html#aa0c7b20b2866108c5e232ff70bea4820a336a54b375b03cc744f69189037af991">kParseSuccess</a>,
<a class="el" href="namespacelivox.html#aa0c7b20b2866108c5e232ff70bea4820a397580937b025c53bf21690ebeb11e7a">kParseFail</a>
}</td></tr>
<tr class="separator:aa0c7b20b2866108c5e232ff70bea4820"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aa902d8a50576dcdede27023c03f65747"><td class="memItemLeft" align="right" valign="top">const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#aa902d8a50576dcdede27023c03f65747">kCacheSize</a> = 8192</td></tr>
<tr class="separator:aa902d8a50576dcdede27023c03f65747"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4db2ee1c995aba81900420b7e4312bc1"><td class="memItemLeft" align="right" valign="top">const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelivox.html#a4db2ee1c995aba81900420b7e4312bc1">kMoveCacheLimit</a> = 1536</td></tr>
<tr class="separator:a4db2ee1c995aba81900420b7e4312bc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="af4e436d907dcafb14fcc88a760f75090"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structlivox_1_1_comm_packet.html">livox::CommPacket</a> <a class="el" href="structlivox_1_1_comm_packet.html">livox::CommPacket</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="protocol_8h_source.html#l00031">31</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad7370a98d65fd20693ed58a470ec9439"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* livox::RequestPackCb) (<a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> *packet)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="protocol_8h_source.html#l00033">33</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="afeebe28eda25022afdc079c1aaff209c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacelivox.html#afeebe28eda25022afdc079c1aaff209c">livox::NeedAckType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="afeebe28eda25022afdc079c1aaff209ca04b4a83f4d5f6af89e52b2d9cfadbb24"></a>kNoNeed&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="afeebe28eda25022afdc079c1aaff209ca0bfce7eeeb94e9fa66f051de4e0f8889"></a>kNeedAck&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="afeebe28eda25022afdc079c1aaff209caa59408252d4020dffb9cd35aa5917337"></a>kDelayAck&#160;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="protocol_8h_source.html#l00039">39</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6941cc71243dd1b067c904fdd91bfb61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacelivox.html#a6941cc71243dd1b067c904fdd91bfb61">livox::PacketType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a6941cc71243dd1b067c904fdd91bfb61aac306c9b5938dac53c45dfc4fcc9c132"></a>kRequestPack&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6941cc71243dd1b067c904fdd91bfb61a9686d537f806d748aece1f03b523d50e"></a>kAckPack&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6941cc71243dd1b067c904fdd91bfb61a195c6286a980061276877c88f4347a65"></a>kMsgPack&#160;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="protocol_8h_source.html#l00035">35</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa0c7b20b2866108c5e232ff70bea4820"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacelivox.html#aa0c7b20b2866108c5e232ff70bea4820">livox::ParseResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aa0c7b20b2866108c5e232ff70bea4820a336a54b375b03cc744f69189037af991"></a>kParseSuccess&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aa0c7b20b2866108c5e232ff70bea4820a397580937b025c53bf21690ebeb11e7a"></a>kParseFail&#160;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="protocol_8h_source.html#l00041">41</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab97b5b082d8b27d02cd14daeb8c9807c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacelivox.html#ab97b5b082d8b27d02cd14daeb8c9807c">livox::ProtocolType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ab97b5b082d8b27d02cd14daeb8c9807caa1131d8950d9c7527cafd32ececda15d"></a>kLidarSdk&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ab97b5b082d8b27d02cd14daeb8c9807ca74908aea2df12e49a212f0b00bae1b25"></a>kRsvd1&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ab97b5b082d8b27d02cd14daeb8c9807ca892dd3366a89802324e48987b8cb34e1"></a>kProtocolUndef&#160;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="protocol_8h_source.html#l00037">37</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="aa902d8a50576dcdede27023c03f65747"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint32_t livox::kCacheSize = 8192</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="comm__port_8h_source.html#l00032">32</a> of file <a class="el" href="comm__port_8h_source.html">comm_port.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4db2ee1c995aba81900420b7e4312bc1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint32_t livox::kMoveCacheLimit = 1536</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="comm__port_8h_source.html#l00033">33</a> of file <a class="el" href="comm__port_8h_source.html">comm_port.h</a>.</p>
</div>
</div>
</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="namespacelivox.html">livox</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>