Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 1269

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!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>CObservationOdometry.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> &gt; <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<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><a href="pages.html"><span>Related&#160;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><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
          <div class="left">
            <form id="FSearchBox" action="search.php" method="get">
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
            </form>
          </div><div class="right"></div>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">CObservationOdometry.h</div>  </div>
</div>
<div class="contents">
<a href="_c_observation_odometry_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment">   |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |</span>
<a name="l00003"></a>00003 <span class="comment">   |                                                                           |</span>
<a name="l00004"></a>00004 <span class="comment">   |                       http://www.mrpt.org/                                |</span>
<a name="l00005"></a>00005 <span class="comment">   |                                                                           |</span>
<a name="l00006"></a>00006 <span class="comment">   |   Copyright (C) 2005-2011  University of Malaga                           |</span>
<a name="l00007"></a>00007 <span class="comment">   |                                                                           |</span>
<a name="l00008"></a>00008 <span class="comment">   |    This software was written by the Machine Perception and Intelligent    |</span>
<a name="l00009"></a>00009 <span class="comment">   |      Robotics Lab, University of Malaga (Spain).                          |</span>
<a name="l00010"></a>00010 <span class="comment">   |    Contact: Jose-Luis Blanco  &lt;jlblanco@ctima.uma.es&gt;                     |</span>
<a name="l00011"></a>00011 <span class="comment">   |                                                                           |</span>
<a name="l00012"></a>00012 <span class="comment">   |  This file is part of the MRPT project.                                   |</span>
<a name="l00013"></a>00013 <span class="comment">   |                                                                           |</span>
<a name="l00014"></a>00014 <span class="comment">   |     MRPT is free software: you can redistribute it and/or modify          |</span>
<a name="l00015"></a>00015 <span class="comment">   |     it under the terms of the GNU General Public License as published by  |</span>
<a name="l00016"></a>00016 <span class="comment">   |     the Free Software Foundation, either version 3 of the License, or     |</span>
<a name="l00017"></a>00017 <span class="comment">   |     (at your option) any later version.                                   |</span>
<a name="l00018"></a>00018 <span class="comment">   |                                                                           |</span>
<a name="l00019"></a>00019 <span class="comment">   |   MRPT is distributed in the hope that it will be useful,                 |</span>
<a name="l00020"></a>00020 <span class="comment">   |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |</span>
<a name="l00021"></a>00021 <span class="comment">   |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |</span>
<a name="l00022"></a>00022 <span class="comment">   |     GNU General Public License for more details.                          |</span>
<a name="l00023"></a>00023 <span class="comment">   |                                                                           |</span>
<a name="l00024"></a>00024 <span class="comment">   |     You should have received a copy of the GNU General Public License     |</span>
<a name="l00025"></a>00025 <span class="comment">   |     along with MRPT.  If not, see &lt;http://www.gnu.org/licenses/&gt;.         |</span>
<a name="l00026"></a>00026 <span class="comment">   |                                                                           |</span>
<a name="l00027"></a>00027 <span class="comment">   +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef CObservationOdometry_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define CObservationOdometry_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;<a class="code" href="_c_serializable_8h.html">mrpt/utils/CSerializable.h</a>&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;<a class="code" href="_c_observation_8h.html">mrpt/slam/CObservation.h</a>&gt;</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;<a class="code" href="_c_pose2_d_8h.html">mrpt/poses/CPose2D.h</a>&gt;</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;<a class="code" href="_c_pose3_d_8h.html">mrpt/poses/CPose3D.h</a>&gt;</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="keyword">namespace </span>mrpt
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039         <span class="keyword">namespace </span>slam
<a name="l00040"></a>00040         {
<a name="l00041"></a><a class="code" href="structmrpt_1_1slam_1_1_c_observation_odometry_ptr.html#a0fcd5d21a290b3111badadb1f99ee7d1">00041</a>                 <a class="code" href="_c_serializable_8h.html#a9ef523d787f6cb837a0585b790882588" title="This declaration must be inserted in all CSerializable classes definition, before the class declarati...">DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE</a>( <a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html" title="An observation of the current (cumulative) odometry for a wheeled robot.">CObservationOdometry</a>, <a class="code" href="classmrpt_1_1slam_1_1_c_observation.html" title="Declares a class that represents any robot&#39;s observation.">CObservation</a>,<a class="code" href="obs_2include_2mrpt_2obs_2link__pragmas_8h.html#ae8bb1b2647c58d6ae2eb30ca31fcf5a1">OBS_IMPEXP</a>  )
<a name="l00042"></a>00042 
<a name="l00043"></a>00043                 <span class="comment">/** An observation of the current (cumulative) odometry for a wheeled robot.</span>
<a name="l00044"></a>00044 <span class="comment">                 *   This kind of observation will only occur in a &quot;observation-only&quot; rawlog file, otherwise</span>
<a name="l00045"></a>00045 <span class="comment">                 *    odometry are modeled with actions. Refer to the &lt;a href=&quot;http://www.mrpt.org/Rawlog_Format&quot;&gt;page on rawlogs&lt;/a&gt;.</span>
<a name="l00046"></a>00046 <span class="comment">                 *</span>
<a name="l00047"></a>00047 <span class="comment">                 * \sa CObservation, CActionRobotMovement2D</span>
<a name="l00048"></a>00048 <span class="comment">                 * \ingroup mrpt_obs_grp</span>
<a name="l00049"></a>00049 <span class="comment">                 */</span>
<a name="l00050"></a>00050                 class <a class="code" href="obs_2include_2mrpt_2obs_2link__pragmas_8h.html#ae8bb1b2647c58d6ae2eb30ca31fcf5a1">OBS_IMPEXP</a> <a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html" title="An observation of the current (cumulative) odometry for a wheeled robot.">CObservationOdometry</a> : public <a class="code" href="classmrpt_1_1slam_1_1_c_observation.html" title="Declares a class that represents any robot&#39;s observation.">CObservation</a>
<a name="l00051"></a>00051                 {
<a name="l00052"></a>00052                         <span class="comment">// This must be added to any CSerializable derived class:</span>
<a name="l00053"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a300acfcaada4bbdaaf71205cc467c54b">00053</a>                         <a class="code" href="_c_serializable_8h.html#a72ab55bf7ae009c89b75715cfa21e84d" title="This declaration must be inserted in all CSerializable classes definition, within the class declarati...">DEFINE_SERIALIZABLE</a>( <a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html" title="An observation of the current (cumulative) odometry for a wheeled robot.">CObservationOdometry</a> )
<a name="l00054"></a>00054 
<a name="l00055"></a>00055                  public:<span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">                        /** Constructor</span>
<a name="l00057"></a>00057 <span class="comment">                         */</span>
<a name="l00058"></a>00058                         <a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html" title="An observation of the current (cumulative) odometry for a wheeled robot.">CObservationOdometry</a>( );
<a name="l00059"></a>00059 
<a name="l00060"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a4b618b765d3227a91ec4fe99b2a15791">00060</a>                         poses::<a class="code" href="classmrpt_1_1poses_1_1_c_pose2_d.html" title="A class used to store a 2D pose.">CPose2D</a>          odometry;               <span class="comment">//!&lt; The absolute odometry measurement (IT IS NOT INCREMENTAL)</span>
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a00af1ec663c56d8717e5873ef918b20e">00062</a>                         <span class="keywordtype">bool</span>  hasEncodersInfo; <span class="comment">//!&lt; &quot;true&quot; means that &quot;encoderLeftTicks&quot; and &quot;encoderRightTicks&quot; contain valid values.</span>
<a name="l00063"></a>00063 <span class="comment"></span><span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment">                        /** For odometry only: the ticks count for each wheel in ABSOLUTE VALUE (IT IS NOT INCREMENTAL) (positive means FORWARD, for both wheels);</span>
<a name="l00065"></a>00065 <span class="comment">                          * \sa hasEncodersInfo</span>
<a name="l00066"></a>00066 <span class="comment">                          */</span>
<a name="l00067"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a2d1c925330b44c0af0d60ccba8c58b09">00067</a>                         int32_t  encoderLeftTicks,encoderRightTicks;
<a name="l00068"></a>00068 
<a name="l00069"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a4374838efbe8cce3764d2391501f37b0">00069</a>                         <span class="keywordtype">bool</span>    hasVelocities;          <span class="comment">//!&lt; &quot;true&quot; means that &quot;velocityLin&quot; and &quot;velocityAng&quot; contain valid values.</span>
<a name="l00070"></a>00070 <span class="comment"></span><span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment">                        /** The velocity of the robot, linear in meters/sec and angular in rad/sec.</span>
<a name="l00072"></a>00072 <span class="comment">                          */</span>
<a name="l00073"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a3910228de7a639e3f2ea727e9450e503">00073</a>                         <span class="keywordtype">float</span>   velocityLin, velocityAng;
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">                        /** A general method to retrieve the sensor pose on the robot.</span>
<a name="l00077"></a>00077 <span class="comment">                          *  It has no effects in this class</span>
<a name="l00078"></a>00078 <span class="comment">                          * \sa setSensorPose</span>
<a name="l00079"></a>00079 <span class="comment">                          */</span>
<a name="l00080"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a834cd09091fa98d9770cc6a3d2685ec2">00080</a>                         <span class="keywordtype">void</span> getSensorPose( <a class="code" href="classmrpt_1_1poses_1_1_c_pose3_d.html" title="A class used to store a 3D pose (a 3D translation + a rotation in 3D).">CPose3D</a> &amp;out_sensorPose )<span class="keyword"> const </span>{ out_sensorPose=<a class="code" href="classmrpt_1_1poses_1_1_c_pose3_d.html" title="A class used to store a 3D pose (a 3D translation + a rotation in 3D).">CPose3D</a>(0,0,0); }
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">                        /** A general method to change the sensor pose on the robot.</span>
<a name="l00083"></a>00083 <span class="comment">                          *  It has no effects in this class</span>
<a name="l00084"></a>00084 <span class="comment">                          * \sa getSensorPose</span>
<a name="l00085"></a>00085 <span class="comment">                          */</span>
<a name="l00086"></a><a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a27291491a7d6c85b87d00e4c82f15f28">00086</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1slam_1_1_c_observation_odometry.html#a27291491a7d6c85b87d00e4c82f15f28" title="A general method to change the sensor pose on the robot.">setSensorPose</a>( <span class="keyword">const</span> <a class="code" href="classmrpt_1_1poses_1_1_c_pose3_d.html" title="A class used to store a 3D pose (a 3D translation + a rotation in 3D).">CPose3D</a> &amp; ) {  }
<a name="l00087"></a>00087 
<a name="l00088"></a>00088                 }; <span class="comment">// End of class def.</span>
<a name="l00089"></a>00089 
<a name="l00090"></a>00090         } <span class="comment">// End of namespace</span>
<a name="l00091"></a>00091 } <span class="comment">// End of namespace</span>
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150">  </td></tr> </table>  </body></html>