<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>GearBox Project</title> <link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png"> <link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png"> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> <!-- Google Analytics --> <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-3583782-1"); pageTracker._initData(); pageTracker._trackPageview(); </script> <!-- Returning you to your regular programming --> </head><body> <!-- Header --> <table border="0" cellspacing="0" cellpadding="0"> <tr><!-- create row --> <!-- spacer cell --> <!-- #CC CC CC --> <td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td> <!-- menu cell --> <td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE"> <p> </p> <p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br> <strong>INTRODUCTION</strong><br> <strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br> <strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br> <!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> --> <strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br> <strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br> <br> <strong>REPOSITORY</strong><br> <strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br> <!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> --> <br> <strong>DEVELOPER</strong><br> <!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br> <strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>--> <strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br> <!-- <strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br> --> <strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br> <!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br> login/pass: orca/orca<br>--> <br> <strong>PEOPLE</strong><br> <strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br> <strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br> <br> <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br> <strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br> <strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br> <!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>--> <strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p> <p> </p> </td><!-- /menu cell --> <!-- one grey spacer cells --> <td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td> <!-- one white spacer cells --> <td rowspan="1" colspan="1"> </td> <!-- main content cell --> <td rowspan="1" colspan="1" align="left" valign="top"> <!-- Generated by Doxygen 1.6.2-20100208 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacegbxnovatelacfr.html">gbxnovatelacfr</a>::<a class="el" href="classgbxnovatelacfr_1_1Driver.html">Driver</a> </div> </div> <div class="contents"> <h1>gbxnovatelacfr::Driver Class Reference</h1><!-- doxytag: class="gbxnovatelacfr::Driver" --> <p>the idea is to create one of these guys (with a valid <a class="el" href="classgbxnovatelacfr_1_1Config.html" title="All the information needed to configure the driver.">Config</a>), and then treat it as a data-source, i.e. call <a class="el" href="classgbxnovatelacfr_1_1Driver.html#aa46a6e8dfd1eb792b78867888df56eee" title="Blocking read, returns one message.">read()</a> on it in some kind of loop <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gbxnovatelacfr_2driver_8h_source.html">driver.h</a>></code></p> <p><a href="classgbxnovatelacfr_1_1Driver-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::auto_ptr< <a class="el" href="classgbxnovatelacfr_1_1GenericData.html">GenericData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxnovatelacfr_1_1Driver.html#aa46a6e8dfd1eb792b78867888df56eee">read</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Blocking read, returns one message. <a href="#aa46a6e8dfd1eb792b78867888df56eee"></a><br/></td></tr> <tr><td colspan="2"><div class="groupHeader">Ctor:</div></td></tr> <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp6bbe1cf451bb73c47f5f238c72e8bbe8"></a>Tries to establish serial communication to the GPS receiver, then configures it </p> </div></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxnovatelacfr_1_1Driver.html#ac5970c362299881838dbf4440ed43c21">Driver</a> (const <a class="el" href="classgbxnovatelacfr_1_1Config.html">Config</a> &cfg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">dumps tracing messages to the console <a href="#ac5970c362299881838dbf4440ed43c21"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxnovatelacfr_1_1Driver.html#aeb97f9e06969fba4a296c053e0f9def2">Driver</a> (const <a class="el" href="classgbxnovatelacfr_1_1Config.html">Config</a> &cfg, <a class="el" href="classgbxutilacfr_1_1Tracer.html">gbxutilacfr::Tracer</a> &tracer)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">full control over tracing (e.g. to syslog) <a href="#aeb97f9e06969fba4a296c053e0f9def2"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>the idea is to create one of these guys (with a valid <a class="el" href="classgbxnovatelacfr_1_1Config.html" title="All the information needed to configure the driver.">Config</a>), and then treat it as a data-source, i.e. call <a class="el" href="classgbxnovatelacfr_1_1Driver.html#aa46a6e8dfd1eb792b78867888df56eee" title="Blocking read, returns one message.">read()</a> on it in some kind of loop </p> <p>The actual <a class="el" href="classgbxnovatelacfr_1_1Driver.html" title="the idea is to create one of these guys (with a valid Config), and then treat it...">Driver</a> </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac5970c362299881838dbf4440ed43c21"></a><!-- doxytag: member="gbxnovatelacfr::Driver::Driver" ref="ac5970c362299881838dbf4440ed43c21" args="(const Config &cfg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gbxnovatelacfr::Driver::Driver </td> <td>(</td> <td class="paramtype">const <a class="el" href="classgbxnovatelacfr_1_1Config.html">Config</a> & </td> <td class="paramname"> <em>cfg</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>dumps tracing messages to the console </p> <p>implements tracing internally as a <a class="el" href="classgbxutilacfr_1_1TrivialTracer.html" title="A simple implementation of the tracer API which prints to cout.">gbxutilacfr::TrivialTracer</a> </p> </div> </div> <a class="anchor" id="aeb97f9e06969fba4a296c053e0f9def2"></a><!-- doxytag: member="gbxnovatelacfr::Driver::Driver" ref="aeb97f9e06969fba4a296c053e0f9def2" args="(const Config &cfg, gbxutilacfr::Tracer &tracer)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gbxnovatelacfr::Driver::Driver </td> <td>(</td> <td class="paramtype">const <a class="el" href="classgbxnovatelacfr_1_1Config.html">Config</a> & </td> <td class="paramname"> <em>cfg</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classgbxutilacfr_1_1Tracer.html">gbxutilacfr::Tracer</a> & </td> <td class="paramname"> <em>tracer</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>full control over tracing (e.g. to syslog) </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>tracer</em> </td><td>you need to provide this guy (via new), do NOT delete it, it will be deleted when your <a class="el" href="classgbxnovatelacfr_1_1Driver.html" title="the idea is to create one of these guys (with a valid Config), and then treat it...">Driver</a> object goes out of scope </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa46a6e8dfd1eb792b78867888df56eee"></a><!-- doxytag: member="gbxnovatelacfr::Driver::read" ref="aa46a6e8dfd1eb792b78867888df56eee" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::auto_ptr< <a class="el" href="classgbxnovatelacfr_1_1GenericData.html">GenericData</a> > gbxnovatelacfr::Driver::read </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Blocking read, returns one message. </p> <p>Throws <a class="el" href="classgbxutilacfr_1_1Exception.html" title="Base class for all GbxUtilAcfr exceptions.">gbxutilacfr::Exception</a> when a problem is encountered (derives from std::exception). Throws <a class="el" href="classgbxutilacfr_1_1HardwareException.html" title="This exception is raised when something is wrong with the hardware.">gbxutilacfr::HardwareException</a> when a (fatal) problem with the hardware is encountered </p> <p>References <a class="el" href="gbxnovatelacfr_2driver_8h_source.html#l00135">gbxnovatelacfr::Config::ignoreUnknownMessages_</a>, and <a class="el" href="tracer_8h_source.html#l00141">gbxutilacfr::Tracer::warning()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="gbxnovatelacfr_2driver_8h_source.html">gbxnovatelacfr/driver.h</a></li> <li>gbxnovatelacfr/driver.cpp</li> </ul> </div> </td> <td colspan="1"> </td> </tr> </table> <!-- end of table --> <hr size="1"><address style="align: right;"><small>Generated for GearBox by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address> </body> </html>