mmr/Livox-SDK
Archived
1
0
Fork 0
Code Issues 105 Pull Requests 11 Actions Packages Projects Releases 9 Wiki Activity
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
74f63da2559ffcb3d694266d408e8dcd3fee49af
Livox-SDK/docs/classlivox_1_1_protocol.html
T
Livox-SDK a490a93b20 feature:support save lvx file for lidar;
2019-05-06 12:33:55 +08:00

385 lines
16 KiB
HTML
Raw Blame History

<!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>Livox SDK API: livox::Protocol Class 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="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">V1.1.0</span>
</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 -->
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classlivox_1_1_protocol.html','');});
/* @license-end */
</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="#pub-methods">Public Member Functions</a> &#124;
<a href="classlivox_1_1_protocol-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">livox::Protocol Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="protocol_8h_source.html">protocol.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad44a13b2298df2c134bb41537a2d8706"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#ad44a13b2298df2c134bb41537a2d8706">~Protocol</a> ()</td></tr>
<tr class="separator:ad44a13b2298df2c134bb41537a2d8706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0327374f8c1e7008805b8d87732fe4b8"><td class="memItemLeft" align="right" valign="top">virtual int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#a0327374f8c1e7008805b8d87732fe4b8">ParsePacket</a> (uint8_t *i_buf, uint32_t i_len, <a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> *o_packet)=0</td></tr>
<tr class="separator:a0327374f8c1e7008805b8d87732fe4b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52573a66bbd0f40a624e23ec76465045"><td class="memItemLeft" align="right" valign="top">virtual int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#a52573a66bbd0f40a624e23ec76465045">Pack</a> (uint8_t *o_buf, uint32_t o_buf_size, uint32_t *o_len, const <a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> &amp;i_packet)=0</td></tr>
<tr class="separator:a52573a66bbd0f40a624e23ec76465045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66113a1c1b0f523f05411ef3fab97808"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#a66113a1c1b0f523f05411ef3fab97808">GetPreambleLen</a> ()=0</td></tr>
<tr class="separator:a66113a1c1b0f523f05411ef3fab97808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc5dbf8f0b6e52622fd5c6185db18aba"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#afc5dbf8f0b6e52622fd5c6185db18aba">GetPacketWrapperLen</a> ()=0</td></tr>
<tr class="separator:afc5dbf8f0b6e52622fd5c6185db18aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a3949d5d8b4ed37a895cc3a53569200"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#a8a3949d5d8b4ed37a895cc3a53569200">GetPacketLen</a> (uint8_t *buf)=0</td></tr>
<tr class="separator:a8a3949d5d8b4ed37a895cc3a53569200"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaf1a7dbf16f2deee49ded19e17a998a"><td class="memItemLeft" align="right" valign="top">virtual int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#acaf1a7dbf16f2deee49ded19e17a998a">CheckPreamble</a> (uint8_t *buf)=0</td></tr>
<tr class="separator:acaf1a7dbf16f2deee49ded19e17a998a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af29b4a6d2966e31e19b7f640414ebeb7"><td class="memItemLeft" align="right" valign="top">virtual int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_protocol.html#af29b4a6d2966e31e19b7f640414ebeb7">CheckPacket</a> (uint8_t *buf)=0</td></tr>
<tr class="separator:af29b4a6d2966e31e19b7f640414ebeb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="protocol_8h_source.html#l00062">62</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad44a13b2298df2c134bb41537a2d8706"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad44a13b2298df2c134bb41537a2d8706">&#9670;&nbsp;</a></span>~Protocol()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual livox::Protocol::~Protocol </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="protocol_8h_source.html#l00064">64</a> of file <a class="el" href="protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af29b4a6d2966e31e19b7f640414ebeb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af29b4a6d2966e31e19b7f640414ebeb7">&#9670;&nbsp;</a></span>CheckPacket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t livox::Protocol::CheckPacket </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acaf1a7dbf16f2deee49ded19e17a998a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaf1a7dbf16f2deee49ded19e17a998a">&#9670;&nbsp;</a></span>CheckPreamble()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t livox::Protocol::CheckPreamble </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8a3949d5d8b4ed37a895cc3a53569200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a3949d5d8b4ed37a895cc3a53569200">&#9670;&nbsp;</a></span>GetPacketLen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t livox::Protocol::GetPacketLen </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afc5dbf8f0b6e52622fd5c6185db18aba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc5dbf8f0b6e52622fd5c6185db18aba">&#9670;&nbsp;</a></span>GetPacketWrapperLen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t livox::Protocol::GetPacketWrapperLen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a66113a1c1b0f523f05411ef3fab97808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66113a1c1b0f523f05411ef3fab97808">&#9670;&nbsp;</a></span>GetPreambleLen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t livox::Protocol::GetPreambleLen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a52573a66bbd0f40a624e23ec76465045"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52573a66bbd0f40a624e23ec76465045">&#9670;&nbsp;</a></span>Pack()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t livox::Protocol::Pack </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>o_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>o_buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>o_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> &amp;&#160;</td>
<td class="paramname"><em>i_packet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0327374f8c1e7008805b8d87732fe4b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0327374f8c1e7008805b8d87732fe4b8">&#9670;&nbsp;</a></span>ParsePacket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t livox::Protocol::ParsePacket </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>i_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>i_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> *&#160;</td>
<td class="paramname"><em>o_packet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sdk_core/include/comm/<a class="el" href="protocol_8h_source.html">protocol.h</a></li>
</ul>
</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="navelem"><a class="el" href="classlivox_1_1_protocol.html">Protocol</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.15 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink