<!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_1Config.html">Config</a>
</div>
</div>
<div class="contents">
<h1>gbxgarminacfr::Config Class Reference</h1><!-- doxytag: class="gbxgarminacfr::Config" -->
<p>Configuration structure.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gbxgarminacfr_2driver_8h_source.html">driver.h</a>></code></p>
<p><a href="classgbxgarminacfr_1_1Config-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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#a234caa76897d228203ca1aee33edc5e5">isValid</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94ed0b3fb7c1f1d16333648fedb0011f"></a><!-- doxytag: member="gbxgarminacfr::Config::toString" ref="a94ed0b3fb7c1f1d16333648fedb0011f" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#a94ed0b3fb7c1f1d16333648fedb0011f">toString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns human-readable configuration description. <br/></td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6702d52ab06e1dddb3974e64dad0e773"></a><!-- doxytag: member="gbxgarminacfr::Config::device" ref="a6702d52ab06e1dddb3974e64dad0e773" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#a6702d52ab06e1dddb3974e64dad0e773">device</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serial device. e.g. "/dev/ttyS0". <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b53d5a95a926f52c7057745f9e88de9"></a><!-- doxytag: member="gbxgarminacfr::Config::readGga" ref="a6b53d5a95a926f52c7057745f9e88de9" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#a6b53d5a95a926f52c7057745f9e88de9">readGga</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read GPGGA sentence. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a265a93fd8d8653ddd4b794e03eb4b4fd"></a><!-- doxytag: member="gbxgarminacfr::Config::readVtg" ref="a265a93fd8d8653ddd4b794e03eb4b4fd" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#a265a93fd8d8653ddd4b794e03eb4b4fd">readVtg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read GPVTG sentence. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a844ca8029a8465acc751f4c113e8378a"></a><!-- doxytag: member="gbxgarminacfr::Config::readRme" ref="a844ca8029a8465acc751f4c113e8378a" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#a844ca8029a8465acc751f4c113e8378a">readRme</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read PGRME sentence. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxgarminacfr_1_1Config.html#ae4505f5744b8bdd7e6a43139d6679049">ignoreUnknown</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Configuration structure. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a234caa76897d228203ca1aee33edc5e5"></a><!-- doxytag: member="gbxgarminacfr::Config::isValid" ref="a234caa76897d228203ca1aee33edc5e5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gbxgarminacfr::Config::isValid </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the configuration is sane. Checks include:</p>
<ul>
<li>a non-empty device name</li>
<li>at least one read-sentence flag set to TRUE </li>
</ul>
<p>References <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00040">device</a>, <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00043">readGga</a>, <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00047">readRme</a>, and <a class="el" href="gbxgarminacfr_2driver_8h_source.html#l00045">readVtg</a>.</p>
<p>Referenced by <a class="el" href="gbxgarminacfr_2driver_8cpp_source.html#l00209">gbxgarminacfr::Driver::Driver()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae4505f5744b8bdd7e6a43139d6679049"></a><!-- doxytag: member="gbxgarminacfr::Config::ignoreUnknown" ref="ae4505f5744b8bdd7e6a43139d6679049" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classgbxgarminacfr_1_1Config.html#ae4505f5744b8bdd7e6a43139d6679049">gbxgarminacfr::Config::ignoreUnknown</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ignore unknown messages. This driver tries to turn off all messages and then explicitely enables the ones it understands. But with some devices this does not work and many messages types are received. When ignoreUnknown is set to TRUE the driver quietly ignores the messages it does not understand. </p>
<p>Referenced by <a class="el" href="gbxgarminacfr_2driver_8cpp_source.html#l00308">gbxgarminacfr::Driver::read()</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>
