<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacehokuyo__aist.html">hokuyo_aist</a>::<a class="el" href="classhokuyo__aist_1_1HokuyoData.html">HokuyoData</a>
</div>
</div>
<div class="contents">
<h1>hokuyo_aist::HokuyoData Class Reference</h1><!-- doxytag: class="hokuyo_aist::HokuyoData" -->
<p>Structure to store data returned from the laser scanner.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="hokuyo__aist_8h_source.html">hokuyo_aist.h</a>></code></p>
<p>Inherited by HokuyoDataWrap.</p>
<p><a href="classhokuyo__aist_1_1HokuyoData-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51597baba916bc143600f6192474aff2"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::HokuyoData" ref="a51597baba916bc143600f6192474aff2" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a51597baba916bc143600f6192474aff2">HokuyoData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor creates an empty <a class="el" href="classhokuyo__aist_1_1HokuyoData.html" title="Structure to store data returned from the laser scanner.">HokuyoData</a> with no data currently allocated. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab17bb16f9cb40c2bece01f3e6489db2a"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::HokuyoData" ref="ab17bb16f9cb40c2bece01f3e6489db2a" args="(uint32_t *ranges, unsigned int length, bool error, unsigned int time)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#ab17bb16f9cb40c2bece01f3e6489db2a">HokuyoData</a> (uint32_t *ranges, unsigned int length, bool error, unsigned int time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor performs a deep copy of existing range data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45e5fec3c2f82972d0b84ec65be97619"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::HokuyoData" ref="a45e5fec3c2f82972d0b84ec65be97619" args="(uint32_t *ranges, uint32_t *intensities, unsigned int length, bool error, unsigned int time)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a45e5fec3c2f82972d0b84ec65be97619">HokuyoData</a> (uint32_t *ranges, uint32_t *intensities, unsigned int length, bool error, unsigned int time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor performs a deep copy of existing range and intensity data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15c572c2a40499e75f4b6bc0d0eb47f0"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::HokuyoData" ref="a15c572c2a40499e75f4b6bc0d0eb47f0" args="(const HokuyoData &rhs)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a15c572c2a40499e75f4b6bc0d0eb47f0">HokuyoData</a> (const <a class="el" href="classhokuyo__aist_1_1HokuyoData.html">HokuyoData</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This copy constructor performs a deep copy of present data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const uint32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a7566fb7b1de34f4be3c8aab64fe7c023">Ranges</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to an array of range readings in millimetres. <a href="#a7566fb7b1de34f4be3c8aab64fe7c023"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7ec6d8bb176e4fcc4744f969b6882c4"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::Intensities" ref="ac7ec6d8bb176e4fcc4744f969b6882c4" args="() const " -->
const uint32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#ac7ec6d8bb176e4fcc4744f969b6882c4">Intensities</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to an array of intensity readings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14106aea195e4a6969367056b00a8cf1"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::Length" ref="a14106aea195e4a6969367056b00a8cf1" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a14106aea195e4a6969367056b00a8cf1">Length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of samples in the data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a5ddea552d02515f49eca75c5391d2808">GetErrorStatus</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates if one or more steps had an error. <a href="#a5ddea552d02515f49eca75c5391d2808"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8cdd1ea12816e7cf40891f1cf05bfd0"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::ErrorCodeToString" ref="aa8cdd1ea12816e7cf40891f1cf05bfd0" args="(uint32_t errorCode)" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#aa8cdd1ea12816e7cf40891f1cf05bfd0">ErrorCodeToString</a> (uint32_t errorCode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string representing the error for the given error code. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4c476f1045cbb52fa09310e7ef31eff"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::TimeStamp" ref="ad4c476f1045cbb52fa09310e7ef31eff" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#ad4c476f1045cbb52fa09310e7ef31eff">TimeStamp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the time stamp of the data in milliseconds (only available using SCIP version 2). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefc1e3e84c5176244af03532c8703b49"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::operator=" ref="aefc1e3e84c5176244af03532c8703b49" args="(const HokuyoData &rhs)" -->
<a class="el" href="classhokuyo__aist_1_1HokuyoData.html">HokuyoData</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#aefc1e3e84c5176244af03532c8703b49">operator=</a> (const <a class="el" href="classhokuyo__aist_1_1HokuyoData.html">HokuyoData</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5449063b4e4e22af1b9da54fe919a4e4"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::operator[]" ref="a5449063b4e4e22af1b9da54fe919a4e4" args="(unsigned int index)" -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a5449063b4e4e22af1b9da54fe919a4e4">operator[]</a> (unsigned int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscript operator. Provides direct access to an element of the range data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e3384f53fd9008b845582f45ed7ced9"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::AsString" ref="a7e3384f53fd9008b845582f45ed7ced9" args="()" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a7e3384f53fd9008b845582f45ed7ced9">AsString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Format the entire object into a string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89096b274c74d17b8cec0d25ad79368e"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::CleanUp" ref="a89096b274c74d17b8cec0d25ad79368e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhokuyo__aist_1_1HokuyoData.html#a89096b274c74d17b8cec0d25ad79368e">CleanUp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Force the data to clean up. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Structure to store data returned from the laser scanner. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ddea552d02515f49eca75c5391d2808"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::GetErrorStatus" ref="a5ddea552d02515f49eca75c5391d2808" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hokuyo_aist::HokuyoData::GetErrorStatus </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates if one or more steps had an error. </p>
<p>A step's value will be less than 20 if it had an error. Use <a class="el" href="classhokuyo__aist_1_1HokuyoData.html#aa8cdd1ea12816e7cf40891f1cf05bfd0">ErrorCodeToString</a> to get a textual representation of the error. </p>
<p>Referenced by <a class="el" href="hokuyo__aist_8cpp_source.html#l00620">HokuyoData()</a>, and <a class="el" href="hokuyo__aist_8cpp_source.html#l00728">operator=()</a>.</p>
</div>
</div>
<a class="anchor" id="a7566fb7b1de34f4be3c8aab64fe7c023"></a><!-- doxytag: member="hokuyo_aist::HokuyoData::Ranges" ref="a7566fb7b1de34f4be3c8aab64fe7c023" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint32_t* hokuyo_aist::HokuyoData::Ranges </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to an array of range readings in millimetres. </p>
<p>Values less than 20mm indicate an error. Check the error value for the data to see a probable cause for the error. Most of the time, it will just be an out-of-range reading. </p>
<p>Referenced by <a class="el" href="hokuyo__aist_8cpp_source.html#l00620">HokuyoData()</a>, and <a class="el" href="hokuyo__aist_8cpp_source.html#l00728">operator=()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="hokuyo__aist_8h_source.html">hokuyo_aist.h</a></li>
<li>hokuyo_aist.cpp</li>
</ul>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
