<!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="namespacegbxgarminacfr.html">gbxgarminacfr</a>::<a class="el" href="classgbxgarminacfr_1_1Driver.html">Driver</a> </div> </div> <div class="contents"> <h1>gbxgarminacfr::Driver Class Reference</h1><!-- doxytag: class="gbxgarminacfr::Driver" --> <p><code>#include <<a class="el" href="gbxgarminacfr_2driver_8h_source.html">driver.h</a>></code></p> <p><a href="classgbxgarminacfr_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Driver.html#aeee5bda2e5b456e12b566edaa9ac9288">Driver</a> (const <a class="el" href="classgbxgarminacfr_1_1Config.html">Config</a> &config, <a class="el" href="classgbxutilacfr_1_1Tracer.html">gbxutilacfr::Tracer</a> &tracer, <a class="el" href="classgbxutilacfr_1_1Status.html">gbxutilacfr::Status</a> &status)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::auto_ptr< <a class="el" href="classgbxgarminacfr_1_1GenericData.html">GenericData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Driver.html#afcd8394bb3a6fdfd11010afb553da635">read</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Garmin GPS driver.</p> <p>All Garmin receivers understand the latest NMEA standard which is called: 0183 version 2.0.</p> <p>This standard dictates a transfer rate of 4800 baud.</p> <p>This driver can read only the following messages (sentences):</p> <ul> <li>GPGGA fix data</li> <li>PGRME (estimated error) - not sent if set to 0183 1.5</li> <li>GPVTG vector track and speed over ground</li> </ul> <p>Processing of individual messages can be disabled in the <a class="el" href="classgbxgarminacfr_1_1Config.html" title="Configuration structure.">Config</a> structure.</p> <p>Note that when fixType contained in the GPGGA is Invalid, all other data in all messages except the time stamps are meaningless.</p> <p>Referennces:</p> <ul> <li><a href="http://en.wikipedia.org/wiki/NMEA">http://en.wikipedia.org/wiki/NMEA</a></li> <li><a href="http://www.gpsinformation.org/dale/interface.htm">http://www.gpsinformation.org/dale/interface.htm</a> </li> </ul> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aeee5bda2e5b456e12b566edaa9ac9288"></a><!-- doxytag: member="gbxgarminacfr::Driver::Driver" ref="aeee5bda2e5b456e12b566edaa9ac9288" args="(const Config &config, gbxutilacfr::Tracer &tracer, gbxutilacfr::Status &status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gbxgarminacfr::Driver::Driver </td> <td>(</td> <td class="paramtype">const <a class="el" href="classgbxgarminacfr_1_1Config.html">Config</a> & </td> <td class="paramname"> <em>config</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> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classgbxutilacfr_1_1Status.html">gbxutilacfr::Status</a> & </td> <td class="paramname"> <em>status</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor</p> <p><a class="el" href="classgbxutilacfr_1_1Tracer.html" title="Local and remote tracing.">gbxutilacfr::Tracer</a> and <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">gbxutilacfr::Status</a> allow (human-readable and machine-readable respectively) external monitorining of the driver's internal state. </p> <p>References <a class="el" href="tracer_8h_source.html#l00157">gbxutilacfr::Tracer::debug()</a>, <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00040">gbxgarminacfr::Config::device</a>, <a class="el" href="gbxgarminacfr_2driver_8cpp_source.html#l00186">gbxgarminacfr::Config::isValid()</a>, and <a class="el" href="gbxgarminacfr_2driver_8cpp_source.html#l00198">gbxgarminacfr::Config::toString()</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="afcd8394bb3a6fdfd11010afb553da635"></a><!-- doxytag: member="gbxgarminacfr::Driver::read" ref="afcd8394bb3a6fdfd11010afb553da635" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::auto_ptr< <a class="el" href="classgbxgarminacfr_1_1GenericData.html">GenericData</a> > gbxgarminacfr::Driver::read </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Blocks till new data is available.</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.</p> <div class="fragment"><pre class="fragment"> std::auto_ptr<gbxgarminacfr::GenericData> data; try { data = device->read(); } catch ( const std::exception& e ) { cout <<"Test: Failed to read data: "<<e.what()<<endl; } </pre></div> <p>References <a class="el" href="tracer_8h_source.html#l00157">gbxutilacfr::Tracer::debug()</a>, <a class="el" href="tracer_8h_source.html#l00149">gbxutilacfr::Tracer::error()</a>, <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00052">gbxgarminacfr::Config::ignoreUnknown</a>, <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00043">gbxgarminacfr::Config::readGga</a>, <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00047">gbxgarminacfr::Config::readRme</a>, and <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00045">gbxgarminacfr::Config::readVtg</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="gbxgarminacfr_2driver_8h_source.html">gbxgarminacfr/driver.h</a></li> <li>gbxgarminacfr/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>