<!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>mrpt::hwdrivers::CGenericSensor Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1hwdrivers.html">hwdrivers</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html">CGenericSensor</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="#pri-static-attribs">Static Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::hwdrivers::CGenericSensor Class Reference<div class="ingroups"><a class="el" href="group__mrpt__hwdrivers__grp.html">[mrpt-hwdrivers]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::hwdrivers::CGenericSensor" --><!-- doxytag: inherits="mrpt::utils::CUncopiable" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabber. </p>
<p>Derived classes should be designed with the following execution flow in mind:</p>
<ul>
<li>Object constructor</li>
<li><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a6f34c5b79a128d1cb6b47eaa987ecb51" title="Loads the generic settings common to any sensor (See CGenericSensor), then call to "loadConfig_sensor...">CGenericSensor::loadConfig</a>: The following parameters are common to all sensors in rawlog-grabber (they are automatically loaded by rawlog-grabber) - see each class documentation for additional parameters:<ul>
<li>"process_rate": (Mandatory) The rate in Hertz (Hz) at which the sensor thread should invoke "doProcess".</li>
<li>"max_queue_len": (Optional) The maximum number of objects in the observations queue (default is 200). If overflow occurs, an error message will be issued at run-time.</li>
<li>"grab_decimation": (Optional) Grab only 1 out of N observations captured by the sensor (default is 1, i.e. do not decimate).</li>
</ul>
</li>
<li><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a775782a8fef4c5cd11265024431ed8c3" title="This method can or cannot be implemented in the derived class, depending on the need for it...">CGenericSensor::initialize</a></li>
<li><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a4f02ae5d7a345819f2521f72b633ab51" title="This method will be invoked at a minimum rate of "process_rate" (Hz) method must throw an exception w...">CGenericSensor::doProcess</a></li>
<li><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a34b2a73792cbe176b28c932646bba0ed" title="Returns a list of enqueued objects, emptying it (thread-safe).">CGenericSensor::getObservations</a></li>
</ul>
<p>Notice that there are helper methods for managing the internal list of objects (see <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a03bf6784838d6418f4fe485933a1ab0c" title="Like appendObservations() but for just one observation.">CGenericSensor::appendObservation</a>).</p>
<p><b>Class Factory:</b> This is also a factory of derived classes, through the static method <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ab652d017225fff3050a607f4461b0484" title="Creates a sensor by a name of the class.">CGenericSensor::createSensor</a></p>
<p>For more details on RawLogGrabber refer to the wiki page: <a href="http://www.mrpt.org/Application:RawLogGrabber">http://www.mrpt.org/Application:RawLogGrabber</a> </p>
</div>
<p><code>#include <<a class="el" href="_c_generic_sensor_8h_source.html">mrpt/hwdrivers/CGenericSensor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::hwdrivers::CGenericSensor:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1hwdrivers_1_1_c_generic_sensor__inherit__graph.png" border="0" usemap="#mrpt_1_1hwdrivers_1_1_c_generic_sensor_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1hwdrivers_1_1_c_generic_sensor_inherit__map" id="mrpt_1_1hwdrivers_1_1_c_generic_sensor_inherit__map">
<area shape="rect" id="node5" href="classmrpt_1_1hwdrivers_1_1_c2_d_range_finder_abstract.html" title="This is the base, abstract class for "software drivers" interfaces to 2D scanners (laser range finder..." alt="" coords="517,81,787,108"/><area shape="rect" id="node15" href="classmrpt_1_1hwdrivers_1_1_c_activ_media_robot_base.html" title="This software driver implements the communications (and some rudimentary control) for ActivMedia robo..." alt="" coords="522,132,782,159"/><area shape="rect" id="node17" href="classmrpt_1_1hwdrivers_1_1_c_board_d_l_m_s.html" title="An interface to a custom board which interfaces two SICK laser scanners." alt="" coords="551,183,753,209"/><area shape="rect" id="node19" href="classmrpt_1_1hwdrivers_1_1_c_board_e_noses.html" title="A class for interfacing an e-Noses via a FTDI USB link." alt="" coords="547,233,757,260"/><area shape="rect" id="node21" href="classmrpt_1_1hwdrivers_1_1_c_board_i_r.html" title="A parser of NMEA commands, for connecting to a GPS by a serial port." alt="" coords="563,284,741,311"/><area shape="rect" id="node23" href="classmrpt_1_1hwdrivers_1_1_c_board_sonars.html" title="This "software driver" implements the communication protocol for interfacing a Ultrasonic range finde..." alt="" coords="549,335,755,361"/><area shape="rect" id="node25" href="classmrpt_1_1hwdrivers_1_1_c_camera_sensor.html" title="The central class for camera grabbers in MRPT, implementing the "generic sensor" interface." alt="" coords="543,385,761,412"/><area shape="rect" id="node27" href="classmrpt_1_1hwdrivers_1_1_c_g_p_s_interface.html" title="A parser of NMEA commands, for connecting to a GPS by a serial port." alt="" coords="547,436,757,463"/><area shape="rect" id="node29" href="classmrpt_1_1hwdrivers_1_1_c_gyro_k_v_h_d_s_p3000.html" title="A class for interfacing KVH DSP 3000 gyroscope with an assynchronous serial communication (product SN..." alt="" coords="531,487,773,513"/><area shape="rect" id="node31" href="classmrpt_1_1hwdrivers_1_1_c_ibeo_lux_e_t_h.html" title="This "software driver" implements the communication protocol for interfacing a Ibeo Lux laser scanner..." alt="" coords="551,537,753,564"/><area shape="rect" id="node33" href="classmrpt_1_1hwdrivers_1_1_c_i_m_u_x_sens.html" title="A class for interfacing Inertial Measuring Units (IMUs) of the type "XSens MTi" It uses a serial port..." alt="" coords="555,588,749,615"/><area shape="rect" id="node35" href="classmrpt_1_1hwdrivers_1_1_c_kinect.html" title="A class for grabing "range images", intensity images (either RGB or IR) and other information from an..." alt="" coords="569,639,735,665"/><area shape="rect" id="node37" href="classmrpt_1_1hwdrivers_1_1_c_n_t_r_i_p_emitter.html" title="This "virtual driver" encapsulates a NTRIP client (see CNTRIPClient) but adds the functionality of du..." alt="" coords="545,689,759,716"/><area shape="rect" id="node39" href="classmrpt_1_1hwdrivers_1_1_c_phidget_interface_kit_proximity_sensors.html" title=": An interface for the phidget Interface kit board (1018)." alt="" coords="480,740,824,767"/><area shape="rect" id="node41" href="classmrpt_1_1hwdrivers_1_1_c_ptu_hokuyo.html" title="mrpt::hwdrivers::CPtuHokuyo" alt="" coords="555,791,749,817"/><area shape="rect" id="node43" href="classmrpt_1_1hwdrivers_1_1_c_swiss_ranger3_d_camera.html" title="A class for grabing "range images" from a MESA imaging SwissRanger 3D cameras (SR-2, SR-3000, SR-4k)." alt="" coords="517,841,787,868"/><area shape="rect" id="node45" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html" title="This class implements a wireless power probe." alt="" coords="543,892,761,919"/><area shape="rect" id="node2" href="classmrpt_1_1utils_1_1_c_uncopiable.html" title="The base class of classes that cannot be copied: compile-time errors will be issued on any copy opera..." alt="" coords="5,487,168,513"/><area shape="rect" id="node7" href="classmrpt_1_1hwdrivers_1_1_c_hokuyo_u_r_g.html" title="This software driver implements the protocol SCIP-2.0 for interfacing HOKUYO URG, UTM and UXM laser s..." alt="" coords="880,5,1085,32"/><area shape="rect" id="node9" href="classmrpt_1_1hwdrivers_1_1_c_l_m_s100_eth.html" title="This "software driver" implements the communication protocol for interfacing a SICK LMS100 laser scan..." alt="" coords="883,56,1082,83"/><area shape="rect" id="node11" href="classmrpt_1_1hwdrivers_1_1_c_sick_laser_serial.html" title="This "software driver" implements the communication protocol for interfacing a SICK LMS 2XX laser sca..." alt="" coords="872,107,1093,133"/><area shape="rect" id="node13" href="classmrpt_1_1hwdrivers_1_1_c_sick_laser_u_s_b.html" title="This "software driver" implements the communication protocol for interfacing a SICK LMS2XX laser scan..." alt="" coords="875,157,1091,184"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1hwdrivers_1_1_c_generic_sensor_1_1_c_l_a_s_s_i_n_i_t___g_e_n_e_r_i_c___s_e_n_s_o_r.html">CLASSINIT_GENERIC_SENSOR</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Auxiliary structure used for CSerializable runtime class ID support. <a href="structmrpt_1_1hwdrivers_1_1_c_generic_sensor_1_1_c_l_a_s_s_i_n_i_t___g_e_n_e_r_i_c___s_e_n_s_o_r.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">TSensorState</a> { <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2caba0e2689514dd41d48164e021013549a44">ssInitializing</a> = 0,
<a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cabaacc62e94572e3cd3b4b08caad173a489">ssWorking</a>,
<a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2caba8f76c8318736df85b6805ca460f8d262">ssError</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The current state of the sensor. <a href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classstd_1_1multimap.html">std::multimap</a><br class="typebreak"/>
< <a class="el" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a>, <br class="typebreak"/>
<a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af237beee1de7f3e5733e305921695b30">TListObservations</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef std::pair<br class="typebreak"/>
< <a class="el" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a>, <br class="typebreak"/>
<a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a78712e0c40c510978fb8589774056ab3">TListObsPair</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <br class="typebreak"/>
<a class="el" href="structmrpt_1_1hwdrivers_1_1_t_sensor_class_id.html">mrpt::hwdrivers::TSensorClassId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#afbc26c93b989d1a0cc94c0c88d47cdba">GetRuntimeClass</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">TSensorState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a0bd667caedc6a313d96c232bf75ba577">getState</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The current state of the sensor. <a href="#a0bd667caedc6a313d96c232bf75ba577"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a8a05c268aef7ecada94a0014a2b294f7">getProcessRate</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af3cd061ca684e7ddf5949ed78fced7c9">getSensorLabel</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a044c1340c4b90957250f63fa89189036">setSensorLabel</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &sensorLabel)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a038ddfc613a35d476ac98d132ca3feff">CGenericSensor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a038ddfc613a35d476ac98d132ca3feff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a7e89d8b4ccd096f9d515bcc57992f631">~CGenericSensor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a7e89d8b4ccd096f9d515bcc57992f631"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a6f34c5b79a128d1cb6b47eaa987ecb51">loadConfig</a> (const <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html">mrpt::utils::CConfigFileBase</a> &configSource, const <a class="el" href="classstd_1_1string.html">std::string</a> &section)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the generic settings common to any sensor (See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>), then call to "loadConfig_sensorSpecific" </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method throws an exception with a descriptive message if some critical parameter is missing or has an invalid value. </td></tr>
</table>
</dd>
</dl>
<a href="#a6f34c5b79a128d1cb6b47eaa987ecb51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a775782a8fef4c5cd11265024431ed8c3">initialize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method can or cannot be implemented in the derived class, depending on the need for it. <a href="#a775782a8fef4c5cd11265024431ed8c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a4f02ae5d7a345819f2521f72b633ab51">doProcess</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method will be invoked at a minimum rate of "process_rate" (Hz) </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method must throw an exception with a descriptive message if some critical error is found. </td></tr>
</table>
</dd>
</dl>
<a href="#a4f02ae5d7a345819f2521f72b633ab51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a34b2a73792cbe176b28c932646bba0ed">getObservations</a> (<a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af237beee1de7f3e5733e305921695b30">TListObservations</a> &lstObjects)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of enqueued objects, emptying it (thread-safe). <a href="#a34b2a73792cbe176b28c932646bba0ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#afa55ff06dbf360c8f631d371d6ebe35d">setPathForExternalImages</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &directory)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the path where to save off-rawlog image files (will be ignored in those sensors where this is not applicable). <a href="#afa55ff06dbf360c8f631d371d6ebe35d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aff4b208b901763557196b9326901c582">setExternalImageFormat</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &ext)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg". <a href="#aff4b208b901763557196b9326901c582"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aca05f7ee991ee112b5e9f8f289a9ee94">setExternalImageJPEGQuality</a> (const unsigned int quality)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The quality of JPEG compression, when external images is enabled and the format is "jpg". <a href="#aca05f7ee991ee112b5e9f8f289a9ee94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a9d5aecec9f302feede271c9f1425a323">getExternalImageJPEGQuality</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a640e1b953865c3d2e881bbd2c1a81428">registerClass</a> (const <a class="el" href="structmrpt_1_1hwdrivers_1_1_t_sensor_class_id.html">TSensorClassId</a> *pNewClass)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a class into the internal list of "CGenericSensor" descendents. <a href="#a640e1b953865c3d2e881bbd2c1a81428"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html">CGenericSensor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ab652d017225fff3050a607f4461b0484">createSensor</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &className)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a sensor by a name of the class. <a href="#ab652d017225fff3050a607f4461b0484"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacemrpt_1_1hwdrivers.html#a71aef48ea8dd23e43c706cc1a3ae0e74">CGenericSensorPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aff4e4450e420bf60a2487ab0cff91907">createSensorPtr</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &className)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Just like createSensor, but returning a smart pointer to the newly created sensor object. <a href="#aff4e4450e420bf60a2487ab0cff91907"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ad3a33098f257c379ee6bd1bca24e45f9">appendObservations</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> > &obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method must be called by derived classes to enqueue a new observation in the list to be returned by getObservations. <a href="#ad3a33098f257c379ee6bd1bca24e45f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a03bf6784838d6418f4fe485933a1ab0c">appendObservation</a> (const <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> &obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Like <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ad3a33098f257c379ee6bd1bca24e45f9" title="This method must be called by derived classes to enqueue a new observation in the list to be returned...">appendObservations()</a> but for just one observation. <a href="#a03bf6784838d6418f4fe485933a1ab0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ac867f9cb46c72b4386a5488f171f178f">loadConfig_sensorSpecific</a> (const <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html">mrpt::utils::CConfigFileBase</a> &configSource, const <a class="el" href="classstd_1_1string.html">std::string</a> &section)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads specific configuration for the device from a given source of configuration parameters, for example, an ".ini" file, loading from the section "[iniSection]" (see <a class="el" 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...">utils::CConfigFileBase</a> and derived classes) </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method must throw an exception with a descriptive message if some critical parameter is missing or has an invalid value. </td></tr>
</table>
</dd>
</dl>
<a href="#ac867f9cb46c72b4386a5488f171f178f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a564a6c2bc7f1baaea9a9d90112a7b376">m_grab_decimation_counter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used when "m_grab_decimation" is enabled. <a href="#a564a6c2bc7f1baaea9a9d90112a7b376"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">TSensorState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ab3e8a003783acd03bfd64716640fd67c">m_state</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a06fe84426b813b9c1966c12bb69e6ee6">m_path_for_external_images</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The path where to save off-rawlog images: empty means save images embedded in the rawlog. <a href="#a06fe84426b813b9c1966c12bb69e6ee6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a7d153c5247b0180b6b9df5054d67b183">m_external_images_format</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The extension ("jpg","gif","png",...) that determines the format of images saved externally. <a href="#a7d153c5247b0180b6b9df5054d67b183"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aeac331931fce4890793cd7f1b5f6eb3e">m_external_images_jpeg_quality</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For JPEG images, the quality (default=95%). <a href="#aeac331931fce4890793cd7f1b5f6eb3e"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Common settings to any sensor, loaded in "loadConfig"</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a77094b791971e8f42b94de34f4adb0f7">m_process_rate</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>. <a href="#a77094b791971e8f42b94de34f4adb0f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a6f35448579bd4d27cd4f4685b31a8cc0">m_max_queue_len</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>. <a href="#a6f35448579bd4d27cd4f4685b31a8cc0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a587daaab2cb302eb4cc72eb1396d5f21">m_grab_decimation</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If set to N>=2, only 1 out of N observations will be saved to m_objList. <a href="#a587daaab2cb302eb4cc72eb1396d5f21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#accd4de8daeb5966c191fbc62a5d90355">m_sensorLabel</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>. <a href="#accd4de8daeb5966c191fbc62a5d90355"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">synch::CCriticalSection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a9ff93d86c4c09a910142155f6f789eea">m_csObjList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The critical section for m_objList. <a href="#a9ff93d86c4c09a910142155f6f789eea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af237beee1de7f3e5733e305921695b30">TListObservations</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a48c282eda678708c3a8afdf84529dfab">m_objList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The queue of objects to be returned by getObservations. <a href="#a48c282eda678708c3a8afdf84529dfab"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classstd_1_1map.html">std::map</a>< <a class="el" href="classstd_1_1string.html">std::string</a>, <br class="typebreak"/>
const <a class="el" href="structmrpt_1_1hwdrivers_1_1_t_sensor_class_id.html">TSensorClassId</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ac2a876b33fd0f1d93ee0ecdb252b0985">m_knownClasses</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used in registerClass. <a href="#ac2a876b33fd0f1d93ee0ecdb252b0985"></a><br/></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="af237beee1de7f3e5733e305921695b30"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::TListObservations" ref="af237beee1de7f3e5733e305921695b30" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classstd_1_1multimap.html">std::multimap</a>< <a class="el" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a>, <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> > <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af237beee1de7f3e5733e305921695b30">mrpt::hwdrivers::CGenericSensor::TListObservations</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00084">84</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a78712e0c40c510978fb8589774056ab3"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::TListObsPair" ref="a78712e0c40c510978fb8589774056ab3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::pair< <a class="el" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a>, <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> > <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a78712e0c40c510978fb8589774056ab3">mrpt::hwdrivers::CGenericSensor::TListObsPair</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00085">85</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a44262a8f1ffcc87871fbd717d3fc2cab"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::TSensorState" ref="a44262a8f1ffcc87871fbd717d3fc2cab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">mrpt::hwdrivers::CGenericSensor::TSensorState</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current state of the sensor. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a0bd667caedc6a313d96c232bf75ba577" title="The current state of the sensor.">CGenericSensor::getState</a> </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a44262a8f1ffcc87871fbd717d3fc2caba0e2689514dd41d48164e021013549a44"></a><!-- doxytag: member="ssInitializing" ref="a44262a8f1ffcc87871fbd717d3fc2caba0e2689514dd41d48164e021013549a44" args="" -->ssInitializing</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a44262a8f1ffcc87871fbd717d3fc2cabaacc62e94572e3cd3b4b08caad173a489"></a><!-- doxytag: member="ssWorking" ref="a44262a8f1ffcc87871fbd717d3fc2cabaacc62e94572e3cd3b4b08caad173a489" args="" -->ssWorking</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a44262a8f1ffcc87871fbd717d3fc2caba8f76c8318736df85b6805ca460f8d262"></a><!-- doxytag: member="ssError" ref="a44262a8f1ffcc87871fbd717d3fc2caba8f76c8318736df85b6805ca460f8d262" args="" -->ssError</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00090">90</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a038ddfc613a35d476ac98d132ca3feff"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::CGenericSensor" ref="a038ddfc613a35d476ac98d132ca3feff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::hwdrivers::CGenericSensor::CGenericSensor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a7e89d8b4ccd096f9d515bcc57992f631"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::~CGenericSensor" ref="a7e89d8b4ccd096f9d515bcc57992f631" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::hwdrivers::CGenericSensor::~CGenericSensor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a03bf6784838d6418f4fe485933a1ab0c"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::appendObservation" ref="a03bf6784838d6418f4fe485933a1ab0c" args="(const mrpt::utils::CSerializablePtr &obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::appendObservation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Like <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ad3a33098f257c379ee6bd1bca24e45f9" title="This method must be called by derived classes to enqueue a new observation in the list to be returned...">appendObservations()</a> but for just one observation. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00155">155</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad3a33098f257c379ee6bd1bca24e45f9"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::appendObservations" ref="ad3a33098f257c379ee6bd1bca24e45f9" args="(const std::vector< mrpt::utils::CSerializablePtr > &obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::appendObservations </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">mrpt::utils::CSerializablePtr</a> > & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method must be called by derived classes to enqueue a new observation in the list to be returned by getObservations. </p>
<p>Passed objects must be created in dynamic memory and a smart pointer passed. Example of creation: </p>
<div class="fragment"><pre class="fragment"> CObservationGPSPtr o = CObservationGPSPtr( <span class="keyword">new</span> CObservationGPS() );
o-> .... <span class="comment">// Set data</span>
<a class="code" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a03bf6784838d6418f4fe485933a1ab0c" title="Like appendObservations() but for just one observation.">appendObservation</a>(o);
</pre></div><p> If several observations are passed at once in the vector, they'll be considered as a block regarding the grabbing decimation factor. </p>
</div>
</div>
<a class="anchor" id="ab652d017225fff3050a607f4461b0484"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::createSensor" ref="ab652d017225fff3050a607f4461b0484" args="(const std::string &className)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html">CGenericSensor</a>* mrpt::hwdrivers::CGenericSensor::createSensor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>className</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a sensor by a name of the class. </p>
<p>Typically the user may want to create a smart pointer around the returned pointer, whis is made with: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="namespacemrpt_1_1hwdrivers.html#a71aef48ea8dd23e43c706cc1a3ae0e74">CGenericSensorPtr</a> sensor = <a class="code" href="namespacemrpt_1_1hwdrivers.html#a71aef48ea8dd23e43c706cc1a3ae0e74">CGenericSensorPtr</a>( <a class="code" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ab652d017225fff3050a607f4461b0484" title="Creates a sensor by a name of the class.">CGenericSensor::createSensor</a>(<span class="stringliteral">"XXX"</span>) );
</pre></div> <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a new class, or NULL if class name is unknown. </dd></dl>
</div>
</div>
<a class="anchor" id="aff4e4450e420bf60a2487ab0cff91907"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::createSensorPtr" ref="aff4e4450e420bf60a2487ab0cff91907" args="(const std::string &className)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespacemrpt_1_1hwdrivers.html#a71aef48ea8dd23e43c706cc1a3ae0e74">CGenericSensorPtr</a> mrpt::hwdrivers::CGenericSensor::createSensorPtr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>className</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Just like createSensor, but returning a smart pointer to the newly created sensor object. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00188">188</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4f02ae5d7a345819f2521f72b633ab51"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::doProcess" ref="a4f02ae5d7a345819f2521f72b633ab51" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::hwdrivers::CGenericSensor::doProcess </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method will be invoked at a minimum rate of "process_rate" (Hz) </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method must throw an exception with a descriptive message if some critical error is found. </td></tr>
</table>
</dd>
</dl>
</p>
<p>Implemented in <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_kinect.html#a507b5a2b8ea81eaf344b87e908d29cfa">mrpt::hwdrivers::CKinect</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_camera_sensor.html#a90d45dc1304eb47ae8cf4a3dccfcd798">mrpt::hwdrivers::CCameraSensor</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_ptu_hokuyo.html#adb08ac5e2b6209afdc88cae6058311ea">mrpt::hwdrivers::CPtuHokuyo</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_e_noses.html#a0ceba2b80917a7f666e6300679a27904">mrpt::hwdrivers::CBoardENoses</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c2_d_range_finder_abstract.html#a9ab22161d6d802bcd5c8b609fb8a6b54">mrpt::hwdrivers::C2DRangeFinderAbstract</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_gyro_k_v_h_d_s_p3000.html#a44fd86e4ff9c0b70f153ea381b8d156a">mrpt::hwdrivers::CGyroKVHDSP3000</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_swiss_ranger3_d_camera.html#aaa3c0633b24e5474f2bb8f08cdd94a9f">mrpt::hwdrivers::CSwissRanger3DCamera</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_l_m_s100_eth.html#aa75b469c4121c09e1fc8327d293d5331">mrpt::hwdrivers::CLMS100Eth</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_activ_media_robot_base.html#aafd30144d98061b4fa2b7bc446a7407a">mrpt::hwdrivers::CActivMediaRobotBase</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_phidget_interface_kit_proximity_sensors.html#ad2863fd0ab2649a3b5484bbc0c7d5120">mrpt::hwdrivers::CPhidgetInterfaceKitProximitySensors</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_d_l_m_s.html#ac284061f3388c69f9d82bb5085f4a4a7">mrpt::hwdrivers::CBoardDLMS</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_i_m_u_x_sens.html#a633b34ee5e6acbf5cd63e4a144722d8e">mrpt::hwdrivers::CIMUXSens</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_n_t_r_i_p_emitter.html#a36679506c48fe19dabf367a5231e53a3">mrpt::hwdrivers::CNTRIPEmitter</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_i_r.html#a17385186b351db09fabe26174868381e">mrpt::hwdrivers::CBoardIR</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_sonars.html#ad59dabf3c5a9b6e73dc339430f68e6a5">mrpt::hwdrivers::CBoardSonars</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_g_p_s_interface.html#aac152535cc1e9982ad415e64d18415c5">mrpt::hwdrivers::CGPSInterface</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_ibeo_lux_e_t_h.html#a7a716cc12b7c20f2411a5dd71de105a4">mrpt::hwdrivers::CIbeoLuxETH</a>, and <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#abf525d9253584eca4073aa5f77e57d40">mrpt::hwdrivers::CWirelessPower</a>.</p>
</div>
</div>
<a class="anchor" id="a9d5aecec9f302feede271c9f1425a323"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::getExternalImageJPEGQuality" ref="a9d5aecec9f302feede271c9f1425a323" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int mrpt::hwdrivers::CGenericSensor::getExternalImageJPEGQuality </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00241">241</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a34b2a73792cbe176b28c932646bba0ed"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::getObservations" ref="a34b2a73792cbe176b28c932646bba0ed" args="(TListObservations &lstObjects)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::getObservations </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af237beee1de7f3e5733e305921695b30">TListObservations</a> & </td>
<td class="paramname"><em>lstObjects</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a list of enqueued objects, emptying it (thread-safe). </p>
<p>The objects must be freed by the invoker. </p>
</div>
</div>
<a class="anchor" id="a8a05c268aef7ecada94a0014a2b294f7"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::getProcessRate" ref="a8a05c268aef7ecada94a0014a2b294f7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double mrpt::hwdrivers::CGenericSensor::getProcessRate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00100">100</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="afbc26c93b989d1a0cc94c0c88d47cdba"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::GetRuntimeClass" ref="afbc26c93b989d1a0cc94c0c88d47cdba" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structmrpt_1_1hwdrivers_1_1_t_sensor_class_id.html">mrpt::hwdrivers::TSensorClassId</a>* mrpt::hwdrivers::CGenericSensor::GetRuntimeClass </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af3cd061ca684e7ddf5949ed78fced7c9"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::getSensorLabel" ref="af3cd061ca684e7ddf5949ed78fced7c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> mrpt::hwdrivers::CGenericSensor::getSensorLabel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00102">102</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0bd667caedc6a313d96c232bf75ba577"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::getState" ref="a0bd667caedc6a313d96c232bf75ba577" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">TSensorState</a> mrpt::hwdrivers::CGenericSensor::getState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current state of the sensor. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00098">98</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a775782a8fef4c5cd11265024431ed8c3"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::initialize" ref="a775782a8fef4c5cd11265024431ed8c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::hwdrivers::CGenericSensor::initialize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method can or cannot be implemented in the derived class, depending on the need for it. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method must throw an exception with a descriptive message if some critical error is found. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_kinect.html#ab369f01d9b65a53910442ae3da04bbcf">mrpt::hwdrivers::CKinect</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_camera_sensor.html#ab6c7443ec4fc700a10d3f7840ef22f01">mrpt::hwdrivers::CCameraSensor</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_sick_laser_serial.html#a4074cd3efda8a33671353fd357d46f43">mrpt::hwdrivers::CSickLaserSerial</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_ptu_hokuyo.html#a0adb0eea57c2260c11004984fc0e3202">mrpt::hwdrivers::CPtuHokuyo</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_hokuyo_u_r_g.html#aa59ba12bc09efa95df4e84b8b0982bca">mrpt::hwdrivers::CHokuyoURG</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_e_noses.html#a48867ea4696d2c8d73b3334c37e7fe4f">mrpt::hwdrivers::CBoardENoses</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_gyro_k_v_h_d_s_p3000.html#a022462e21648c8cb02a80bee3d397ef4">mrpt::hwdrivers::CGyroKVHDSP3000</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_l_m_s100_eth.html#ae57ec60cca05cb6c21475821a160297a">mrpt::hwdrivers::CLMS100Eth</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_d_l_m_s.html#aaf906fe3a1cebfe42ca82281a8315139">mrpt::hwdrivers::CBoardDLMS</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_swiss_ranger3_d_camera.html#a480bd45081d7c56bfe425acda4488a97">mrpt::hwdrivers::CSwissRanger3DCamera</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_i_m_u_x_sens.html#abb9c183575154bdf75587703f18990d6">mrpt::hwdrivers::CIMUXSens</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_phidget_interface_kit_proximity_sensors.html#ac4953fcec4eb353c66683e69fe4b1fb7">mrpt::hwdrivers::CPhidgetInterfaceKitProximitySensors</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_n_t_r_i_p_emitter.html#ab7dea7c6896e6b72744a1fdabd508779">mrpt::hwdrivers::CNTRIPEmitter</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_activ_media_robot_base.html#abdebc0341c7eb478a84ea859c15e9997">mrpt::hwdrivers::CActivMediaRobotBase</a>, and <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_ibeo_lux_e_t_h.html#a5b582dff2d7025a951578256de57420a">mrpt::hwdrivers::CIbeoLuxETH</a>.</p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00209">209</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6f34c5b79a128d1cb6b47eaa987ecb51"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::loadConfig" ref="a6f34c5b79a128d1cb6b47eaa987ecb51" args="(const mrpt::utils::CConfigFileBase &configSource, const std::string &section)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::loadConfig </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html">mrpt::utils::CConfigFileBase</a> & </td>
<td class="paramname"><em>configSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>section</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads the generic settings common to any sensor (See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>), then call to "loadConfig_sensorSpecific" </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method throws an exception with a descriptive message if some critical parameter is missing or has an invalid value. </td></tr>
</table>
</dd>
</dl>
</p>
</div>
</div>
<a class="anchor" id="ac867f9cb46c72b4386a5488f171f178f"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::loadConfig_sensorSpecific" ref="ac867f9cb46c72b4386a5488f171f178f" args="(const mrpt::utils::CConfigFileBase &configSource, const std::string &section)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::hwdrivers::CGenericSensor::loadConfig_sensorSpecific </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html">mrpt::utils::CConfigFileBase</a> & </td>
<td class="paramname"><em>configSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>section</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads specific configuration for the device from a given source of configuration parameters, for example, an ".ini" file, loading from the section "[iniSection]" (see <a class="el" 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...">utils::CConfigFileBase</a> and derived classes) </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method must throw an exception with a descriptive message if some critical parameter is missing or has an invalid value. </td></tr>
</table>
</dd>
</dl>
</p>
<p>Implemented in <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_kinect.html#a6f3d7a6ff3902a1e1ec28892af3cd033">mrpt::hwdrivers::CKinect</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_camera_sensor.html#aea35e70d970fffef23f5385cf1615fd7">mrpt::hwdrivers::CCameraSensor</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_hokuyo_u_r_g.html#ac72eb2cedacdcadf0a6405d0d1003f04">mrpt::hwdrivers::CHokuyoURG</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_activ_media_robot_base.html#a4fc185a6ed79faedd35c213e33de6c48">mrpt::hwdrivers::CActivMediaRobotBase</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_swiss_ranger3_d_camera.html#aefc1505de8fe0ee1dacd7664995e3570">mrpt::hwdrivers::CSwissRanger3DCamera</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_l_m_s100_eth.html#a6f86a890bd4cf3d58810116f96af2b22">mrpt::hwdrivers::CLMS100Eth</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_phidget_interface_kit_proximity_sensors.html#af8bd606da0d6e59a1dfe757fc8a0e5eb">mrpt::hwdrivers::CPhidgetInterfaceKitProximitySensors</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_sonars.html#ac18b938a12cb3eb135eec2846c473599">mrpt::hwdrivers::CBoardSonars</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_g_p_s_interface.html#ae6040e96e295ba7878d16fd55a6a7948">mrpt::hwdrivers::CGPSInterface</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_i_r.html#a5d7e5d114f5959fa97ce55e17b85dfc7">mrpt::hwdrivers::CBoardIR</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_ibeo_lux_e_t_h.html#aef3939f0f5ac80e45c0bf3cb17dab527">mrpt::hwdrivers::CIbeoLuxETH</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_gyro_k_v_h_d_s_p3000.html#a9626ac6371e29375a8d4ac6cd0477cee">mrpt::hwdrivers::CGyroKVHDSP3000</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_sick_laser_serial.html#aba6ad2f5e7ba1725b1ba2256312ac202">mrpt::hwdrivers::CSickLaserSerial</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_e_noses.html#a379ac6a5b6855586fd24bf3816433227">mrpt::hwdrivers::CBoardENoses</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_i_m_u_x_sens.html#ae7a836473bb4931233aa18181bc1bbc2">mrpt::hwdrivers::CIMUXSens</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_board_d_l_m_s.html#a74440bed2d455675714726dde0c15685">mrpt::hwdrivers::CBoardDLMS</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_sick_laser_u_s_b.html#a7273e56faad24b134aad0e0baa9b7a3d">mrpt::hwdrivers::CSickLaserUSB</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_n_t_r_i_p_emitter.html#a9ff26f31c977a9f6a396b6111c6d8f7d">mrpt::hwdrivers::CNTRIPEmitter</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_wireless_power.html#a8ae1c33946254e1f83a98e04c0d58551">mrpt::hwdrivers::CWirelessPower</a>, and <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_ptu_hokuyo.html#a4cdc1f3e8a2bdffb5d70fc73a7b8632b">mrpt::hwdrivers::CPtuHokuyo</a>.</p>
</div>
</div>
<a class="anchor" id="a640e1b953865c3d2e881bbd2c1a81428"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::registerClass" ref="a640e1b953865c3d2e881bbd2c1a81428" args="(const TSensorClassId *pNewClass)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mrpt::hwdrivers::CGenericSensor::registerClass </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmrpt_1_1hwdrivers_1_1_t_sensor_class_id.html">TSensorClassId</a> * </td>
<td class="paramname"><em>pNewClass</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a class into the internal list of "CGenericSensor" descendents. </p>
<p>Used internally in the macros DEFINE_GENERIC_SENSOR, etc...</p>
<p>Can be used as "CGenericSensor::registerClass( SENSOR_CLASS_ID(CMySensor) );" if building custom sensors outside mrpt libraries in user code. </p>
</div>
</div>
<a class="anchor" id="aff4b208b901763557196b9326901c582"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::setExternalImageFormat" ref="aff4b208b901763557196b9326901c582" args="(const std::string &ext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::setExternalImageFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>ext</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg". </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#afa55ff06dbf360c8f631d371d6ebe35d" title="Set the path where to save off-rawlog image files (will be ignored in those sensors where this is not...">setPathForExternalImages</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aca05f7ee991ee112b5e9f8f289a9ee94" title="The quality of JPEG compression, when external images is enabled and the format is "jpg"...">setExternalImageJPEGQuality</a> </dd></dl>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00233">233</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="aca05f7ee991ee112b5e9f8f289a9ee94"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::setExternalImageJPEGQuality" ref="aca05f7ee991ee112b5e9f8f289a9ee94" args="(const unsigned int quality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::setExternalImageJPEGQuality </td>
<td>(</td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>quality</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The quality of JPEG compression, when external images is enabled and the format is "jpg". </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aff4b208b901763557196b9326901c582" title="Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The d...">setExternalImageFormat</a> </dd></dl>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00238">238</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="afa55ff06dbf360c8f631d371d6ebe35d"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::setPathForExternalImages" ref="afa55ff06dbf360c8f631d371d6ebe35d" args="(const std::string &directory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::hwdrivers::CGenericSensor::setPathForExternalImages </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>directory</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the path where to save off-rawlog image files (will be ignored in those sensors where this is not applicable). </p>
<p>An empty string (the default value at construction) means to save images embedded in the rawlog, instead of on separate files. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a></td><td>If the directory doesn't exists and cannot be created. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_kinect.html#af1eb1294ff0693595f46c26ede24d115">mrpt::hwdrivers::CKinect</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_camera_sensor.html#a8cc198b85399850d439eda47d832bc8d">mrpt::hwdrivers::CCameraSensor</a>, and <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_swiss_ranger3_d_camera.html#a7392e6fb7a5720f0cbfa6dd02b7ec439">mrpt::hwdrivers::CSwissRanger3DCamera</a>.</p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00225">225</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a044c1340c4b90957250f63fa89189036"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::setSensorLabel" ref="a044c1340c4b90957250f63fa89189036" args="(const std::string &sensorLabel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CGenericSensor::setSensorLabel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>sensorLabel</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00103">103</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9ff93d86c4c09a910142155f6f789eea"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_csObjList" ref="a9ff93d86c4c09a910142155f6f789eea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">synch::CCriticalSection</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a9ff93d86c4c09a910142155f6f789eea">mrpt::hwdrivers::CGenericSensor::m_csObjList</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The critical section for m_objList. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00114">114</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7d153c5247b0180b6b9df5054d67b183"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_external_images_format" ref="a7d153c5247b0180b6b9df5054d67b183" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a7d153c5247b0180b6b9df5054d67b183">mrpt::hwdrivers::CGenericSensor::m_external_images_format</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The extension ("jpg","gif","png",...) that determines the format of images saved externally. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#afa55ff06dbf360c8f631d371d6ebe35d" title="Set the path where to save off-rawlog image files (will be ignored in those sensors where this is not...">setPathForExternalImages</a> </dd></dl>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00139">139</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeac331931fce4890793cd7f1b5f6eb3e"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_external_images_jpeg_quality" ref="aeac331931fce4890793cd7f1b5f6eb3e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#aeac331931fce4890793cd7f1b5f6eb3e">mrpt::hwdrivers::CGenericSensor::m_external_images_jpeg_quality</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For JPEG images, the quality (default=95%). </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00140">140</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a587daaab2cb302eb4cc72eb1396d5f21"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_grab_decimation" ref="a587daaab2cb302eb4cc72eb1396d5f21" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a587daaab2cb302eb4cc72eb1396d5f21">mrpt::hwdrivers::CGenericSensor::m_grab_decimation</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If set to N>=2, only 1 out of N observations will be saved to m_objList. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00127">127</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a564a6c2bc7f1baaea9a9d90112a7b376"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter" ref="a564a6c2bc7f1baaea9a9d90112a7b376" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a564a6c2bc7f1baaea9a9d90112a7b376">mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used when "m_grab_decimation" is enabled. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00132">132</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac2a876b33fd0f1d93ee0ecdb252b0985"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_knownClasses" ref="ac2a876b33fd0f1d93ee0ecdb252b0985" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1map.html">std::map</a>< <a class="el" href="classstd_1_1string.html">std::string</a> , const <a class="el" href="structmrpt_1_1hwdrivers_1_1_t_sensor_class_id.html">TSensorClassId</a> *> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ac2a876b33fd0f1d93ee0ecdb252b0985">mrpt::hwdrivers::CGenericSensor::m_knownClasses</a><code> [static, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used in registerClass. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00118">118</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6f35448579bd4d27cd4f4685b31a8cc0"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_max_queue_len" ref="a6f35448579bd4d27cd4f4685b31a8cc0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a6f35448579bd4d27cd4f4685b31a8cc0">mrpt::hwdrivers::CGenericSensor::m_max_queue_len</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00126">126</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a48c282eda678708c3a8afdf84529dfab"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_objList" ref="a48c282eda678708c3a8afdf84529dfab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#af237beee1de7f3e5733e305921695b30">TListObservations</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a48c282eda678708c3a8afdf84529dfab">mrpt::hwdrivers::CGenericSensor::m_objList</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The queue of objects to be returned by getObservations. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00115">115</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a06fe84426b813b9c1966c12bb69e6ee6"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_path_for_external_images" ref="a06fe84426b813b9c1966c12bb69e6ee6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a06fe84426b813b9c1966c12bb69e6ee6">mrpt::hwdrivers::CGenericSensor::m_path_for_external_images</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The path where to save off-rawlog images: empty means save images embedded in the rawlog. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00138">138</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a77094b791971e8f42b94de34f4adb0f7"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_process_rate" ref="a77094b791971e8f42b94de34f4adb0f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a77094b791971e8f42b94de34f4adb0f7">mrpt::hwdrivers::CGenericSensor::m_process_rate</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00125">125</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="accd4de8daeb5966c191fbc62a5d90355"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_sensorLabel" ref="accd4de8daeb5966c191fbc62a5d90355" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#accd4de8daeb5966c191fbc62a5d90355">mrpt::hwdrivers::CGenericSensor::m_sensorLabel</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html" title="A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...">CGenericSensor</a>. </p>
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00128">128</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab3e8a003783acd03bfd64716640fd67c"></a><!-- doxytag: member="mrpt::hwdrivers::CGenericSensor::m_state" ref="ab3e8a003783acd03bfd64716640fd67c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#a44262a8f1ffcc87871fbd717d3fc2cab">TSensorState</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_generic_sensor.html#ab3e8a003783acd03bfd64716640fd67c">mrpt::hwdrivers::CGenericSensor::m_state</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_generic_sensor_8h_source.html#l00134">134</a> of file <a class="el" href="_c_generic_sensor_8h_source.html">CGenericSensor.h</a>.</p>
</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>
