<!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.10"/>
<title>VectorNav C Library: UART Binary Data Extractors</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>
<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="proglib.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">VectorNav C Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<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="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</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><!-- 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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">UART Binary Data Extractors</div> </div>
</div><!--header-->
<div class="contents">
<p>This group of methods are useful for extracting data from binary data packets.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8c33488adb9d44d21072b34dcfa21601"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#ga8c33488adb9d44d21072b34dcfa21601">VnUartPacket_extractUint8</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:ga8c33488adb9d44d21072b34dcfa21601"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a uint8_t data type from a binary packet and advances the next extraction point appropriately. <a href="#ga8c33488adb9d44d21072b34dcfa21601">More...</a><br /></td></tr>
<tr class="separator:ga8c33488adb9d44d21072b34dcfa21601"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad00a7e842e623c73a76d6c245aa95725"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#gad00a7e842e623c73a76d6c245aa95725">VnUartPacket_extractInt8</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:gad00a7e842e623c73a76d6c245aa95725"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a int8_t data type from a binary packet and advances the next extraction point appropriately. <a href="#gad00a7e842e623c73a76d6c245aa95725">More...</a><br /></td></tr>
<tr class="separator:gad00a7e842e623c73a76d6c245aa95725"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga278d70b97cb5296fc07ed7173acb50d1"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#ga278d70b97cb5296fc07ed7173acb50d1">VnUartPacket_extractUint16</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:ga278d70b97cb5296fc07ed7173acb50d1"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a uint16_t data type from a binary packet and advances the next extraction point appropriately. <a href="#ga278d70b97cb5296fc07ed7173acb50d1">More...</a><br /></td></tr>
<tr class="separator:ga278d70b97cb5296fc07ed7173acb50d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga226ec6598ef9f3041da63b94d6218c98"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#ga226ec6598ef9f3041da63b94d6218c98">VnUartPacket_extractUint32</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:ga226ec6598ef9f3041da63b94d6218c98"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a uint32_t data type from a binary packet and advances the next extraction point appropriately. <a href="#ga226ec6598ef9f3041da63b94d6218c98">More...</a><br /></td></tr>
<tr class="separator:ga226ec6598ef9f3041da63b94d6218c98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6fe1746b5fec18983245f1bd020f39e9"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#ga6fe1746b5fec18983245f1bd020f39e9">VnUartPacket_extractUint64</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:ga6fe1746b5fec18983245f1bd020f39e9"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a uint64_t data type from a binary packet and advances the next extraction point appropriately. <a href="#ga6fe1746b5fec18983245f1bd020f39e9">More...</a><br /></td></tr>
<tr class="separator:ga6fe1746b5fec18983245f1bd020f39e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf89e96757c64209ea52a6963f94c48e8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#gaf89e96757c64209ea52a6963f94c48e8">VnUartPacket_extractFloat</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:gaf89e96757c64209ea52a6963f94c48e8"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a float data type from a binary packet and advances the next extraction point appropriately. <a href="#gaf89e96757c64209ea52a6963f94c48e8">More...</a><br /></td></tr>
<tr class="separator:gaf89e96757c64209ea52a6963f94c48e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab50c5ac1ff646d31e2648fe67c8977e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvec3f.html">vec3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#gab50c5ac1ff646d31e2648fe67c8977e4">VnUartPacket_extractVec3f</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:gab50c5ac1ff646d31e2648fe67c8977e4"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a <a class="el" href="unionvec3f.html" title="Various vector types and operations. ">vec3f</a> data type from a binary packet and advances the next extraction point appropriately. <a href="#gab50c5ac1ff646d31e2648fe67c8977e4">More...</a><br /></td></tr>
<tr class="separator:gab50c5ac1ff646d31e2648fe67c8977e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d1b0512baeae011739cfab8e8dfcecc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvec3d.html">vec3d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#ga2d1b0512baeae011739cfab8e8dfcecc">VnUartPacket_extractVec3d</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:ga2d1b0512baeae011739cfab8e8dfcecc"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a <a class="el" href="unionvec3d.html" title="Represents a 3 component vector with an underlying data type of double. ">vec3d</a> data type from a binary packet and advances the next extraction point appropriately. <a href="#ga2d1b0512baeae011739cfab8e8dfcecc">More...</a><br /></td></tr>
<tr class="separator:ga2d1b0512baeae011739cfab8e8dfcecc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae6a318f365e5f15aca286ff0636bcc5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvec4f.html">vec4f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#gae6a318f365e5f15aca286ff0636bcc5e">VnUartPacket_extractVec4f</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:gae6a318f365e5f15aca286ff0636bcc5e"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a <a class="el" href="unionvec4f.html" title="Represents a 4 component vector with an underlying data type of float. ">vec4f</a> data type from a binary packet and advances the next extraction point appropriately. <a href="#gae6a318f365e5f15aca286ff0636bcc5e">More...</a><br /></td></tr>
<tr class="separator:gae6a318f365e5f15aca286ff0636bcc5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2aafc8af2844100e9ef5adcbe0c9379e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionmat3f.html">mat3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart_packet_binary_extractors.html#ga2aafc8af2844100e9ef5adcbe0c9379e">VnUartPacket_extractMat3f</a> (<a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> *packet)</td></tr>
<tr class="memdesc:ga2aafc8af2844100e9ef5adcbe0c9379e"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a <a class="el" href="unionmat3f.html" title="Represents a 3x3 matrix with an underlying data type of float. ">mat3f</a> data type from a binary packet and advances the next extraction point appropriately. <a href="#ga2aafc8af2844100e9ef5adcbe0c9379e">More...</a><br /></td></tr>
<tr class="separator:ga2aafc8af2844100e9ef5adcbe0c9379e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This group of methods are useful for extracting data from binary data packets. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf89e96757c64209ea52a6963f94c48e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float VnUartPacket_extractFloat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a float data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="gad00a7e842e623c73a76d6c245aa95725"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t VnUartPacket_extractInt8 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a int8_t data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2aafc8af2844100e9ef5adcbe0c9379e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionmat3f.html">mat3f</a> VnUartPacket_extractMat3f </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a <a class="el" href="unionmat3f.html" title="Represents a 3x3 matrix with an underlying data type of float. ">mat3f</a> data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="ga278d70b97cb5296fc07ed7173acb50d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t VnUartPacket_extractUint16 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a uint16_t data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="ga226ec6598ef9f3041da63b94d6218c98"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VnUartPacket_extractUint32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a uint32_t data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6fe1746b5fec18983245f1bd020f39e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t VnUartPacket_extractUint64 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a uint64_t data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="getting_started_2main_8c-example.html#a16">getting_started/main.c</a>, and <a class="el" href="sensor_2main_8c-example.html#a30">sensor/main.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8c33488adb9d44d21072b34dcfa21601"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t VnUartPacket_extractUint8 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a uint8_t data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2d1b0512baeae011739cfab8e8dfcecc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionvec3d.html">vec3d</a> VnUartPacket_extractVec3d </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a <a class="el" href="unionvec3d.html" title="Represents a 3 component vector with an underlying data type of double. ">vec3d</a> data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
<a class="anchor" id="gab50c5ac1ff646d31e2648fe67c8977e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionvec3f.html">vec3f</a> VnUartPacket_extractVec3f </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a <a class="el" href="unionvec3f.html" title="Various vector types and operations. ">vec3f</a> data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="getting_started_2main_8c-example.html#a17">getting_started/main.c</a>, and <a class="el" href="sensor_2main_8c-example.html#a31">sensor/main.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae6a318f365e5f15aca286ff0636bcc5e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionvec4f.html">vec4f</a> VnUartPacket_extractVec4f </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vn_uart_packet.html">VnUartPacket</a> * </td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts a <a class="el" href="unionvec4f.html" title="Represents a 4 component vector with an underlying data type of float. ">vec4f</a> data type from a binary packet and advances the next extraction point appropriately. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet to extract the value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The extracted value. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 3 2017 18:26:58 for VectorNav C Library by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>