<!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>CWirelessPower.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> > <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 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><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 List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CWirelessPower.h</div> </div>
</div>
<div class="contents">
<a href="_c_wireless_power_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: Emil Khatib <emilkhatib@gmail.com> |</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 <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CWirelessPower_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CWirelessPower_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_generic_sensor_8h.html">mrpt/hwdrivers/CGenericSensor.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="_c_observation_wireless_power_8h.html">mrpt/slam/CObservationWirelessPower.h</a>></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="_c_config_file_base_8h.html">mrpt/utils/CConfigFileBase.h</a>></span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>mrpt
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">namespace </span>hwdrivers
<a name="l00038"></a>00038 {<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** This class implements a wireless power probe.</span>
<a name="l00040"></a>00040 <span class="comment"> * \sa mrpt::slam::CWirelessPowerGridMap2D, mrpt::slam::CObservationWirelessPower</span>
<a name="l00041"></a>00041 <span class="comment"> * \ingroup mrpt_hwdrivers_grp</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <span class="keyword">class </span><a class="code" href="hwdrivers__impexp_8h.html#a5bcf681973c7e4e76310bd0791f1b612">HWDRIVERS_IMPEXP</a> CWirelessPower : <span class="keyword">public</span> mrpt::hwdrivers::<a class="code" href="namespacemrpt_1_1hwdrivers.html#a3f369b2dbc16368a52f0ddab62ba5702">CGenericSensor</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <a class="code" href="_c_generic_sensor_8h.html#ab8b72c811c520eb036fa4080d9cd9d1d" title="This declaration must be inserted in all CGenericSensor classes definition, within the class declarat...">DEFINE_GENERIC_SENSOR</a>(CWirelessPower)
<a name="l00046"></a>00046
<a name="l00047"></a>00047 private:<span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment"> /** SSID of the WiFi network</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a><a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#ad785c96cc16dfedb3de536626a82d413">00050</a> std::<span class="keywordtype">string</span> ssid;
<a name="l00051"></a>00051 <span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment"> /** GUID of the WiFi interface</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a><a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#ad11a2885d8441206dc8c7e0a663713f8">00054</a> std::<span class="keywordtype">string</span> guid;
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** Handle to the WLAN server (Windows)</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a><a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#a2ad412f79cdd9e8686c75031ff1b67ea">00058</a> <span class="keywordtype">void</span>* hClient;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 public:<span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /** Default constructor.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html" title="This class implements a wireless power probe.">CWirelessPower</a>();
<a name="l00064"></a><a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#ad9099477cadf32c98ef9946d085ff501">00064</a> virtual ~CWirelessPower(){};
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment"> /** Set the SSID and GUID of the target network.</span>
<a name="l00067"></a>00067 <span class="comment"> * \exception std::exception In case there is a failure</span>
<a name="l00068"></a>00068 <span class="comment"> * \param ssid_ SSID of the target network</span>
<a name="l00069"></a>00069 <span class="comment"> * \param guid_ GUID of the network interface</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a>00071 <span class="keywordtype">void</span> setNet(<a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> ssid_, <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> guid_);
<a name="l00072"></a>00072
<a name="l00073"></a><a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#abf525d9253584eca4073aa5f77e57d40">00073</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#abf525d9253584eca4073aa5f77e57d40" title="This method will be invoked at a minimum rate of "process_rate" (Hz) method must throw an exception w...">doProcess</a>(){};
<a name="l00074"></a>00074 <span class="keywordtype">void</span> loadConfig_sensorSpecific(
<a name="l00075"></a>00075 <span class="keyword">const</span> <a class="code" href="classmrpt_1_1utils_1_1_c_config_file_base.html" title="This class allows loading and storing values and vectors of different types from a configuration text...">mrpt::utils::CConfigFileBase</a> &configSource,
<a name="l00076"></a>00076 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &section);
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** Gets a list of the interfaces</span>
<a name="l00079"></a>00079 <span class="comment"> * \exception std::exception In case there is a failure</span>
<a name="l00080"></a>00080 <span class="comment"> * \return std::vector returns the identifiers (GUID) of the available interfaces</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 std<a class="code" href="classstd_1_1vector.html">::vector<std::string></a> ListInterfaces();
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment"> /** Gets the power of a given network</span>
<a name="l00086"></a>00086 <span class="comment"> * \exception std::exception In case there is a failure</span>
<a name="l00087"></a>00087 <span class="comment"> * \return Returns the power (0-100).</span>
<a name="l00088"></a>00088 <span class="comment"> */</span>
<a name="l00089"></a>00089 <span class="keywordtype">int</span> GetPower();
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /** Gets the power of a given network as a timestamped observation</span>
<a name="l00093"></a>00093 <span class="comment"> * \return Returns true if the observation was correct, and false otherwise</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordtype">bool</span> getObservation( <a class="code" href="classmrpt_1_1slam_1_1_c_observation_wireless_power.html" title="This represents a measurement of the wireless strength perceived by the robot.">mrpt::slam::CObservationWirelessPower</a> &outObservation );
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** Gets a list of the networks available for an interface</span>
<a name="l00100"></a>00100 <span class="comment"> * \exception std::exception In case there is a failure</span>
<a name="l00101"></a>00101 <span class="comment"> * \return std::vector returns handles to the available networks of a given interface</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a>00103 std<a class="code" href="classstd_1_1vector.html">::vector<std::string></a> ListNetworks();
<a name="l00104"></a>00104
<a name="l00105"></a>00105 }; <span class="comment">// End of class def.</span>
<a name="l00106"></a>00106
<a name="l00107"></a>00107 } <span class="comment">// End of namespace</span>
<a name="l00108"></a>00108 } <span class="comment">// End of namespace</span>
<a name="l00109"></a>00109 <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>
