<!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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b8ba9ebcb71a95a44c4fd60b7d348fe1.html">src</a> » <a class="el" href="dir_ecd2e0ae7771ca42ec0b8bcca2f60ddb.html">gbxnovatelacfr</a> » <a class="el" href="dir_b858eda436958a55ca0a86872cd7f538.html">gbxnovatelutilacfr</a>
</div>
</div>
<div class="contents">
<h1>receiverstatusdecoder.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics</span>
<a name="l00003"></a>00003 <span class="comment"> * http://gearbox.sf.net/</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2004-2008 Michael Moser</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This distribution is licensed to you under the terms described in</span>
<a name="l00007"></a>00007 <span class="comment"> * the LICENSE file included in this distribution.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> */</span>
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef GBX_NOVATEL_RECEIVER_STATUS_DECODER_H</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define GBX_NOVATEL_RECEIVER_STATUS_DECODER_H</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include <stdint.h></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <string></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <sstream></span>
<a name="l00016"></a>00016 <span class="keyword">namespace </span>gbxnovatelutilacfr{
<a name="l00017"></a>00017 <span class="keywordtype">bool</span> receiverStatusIsGood(uint32_t receiverStatus){
<a name="l00018"></a>00018 <span class="keywordflow">return</span> 0 == (receiverStatus & 0xe1fe8fef); <span class="comment">// quick cross-check: this magic value needs to be the sum of the magic values in the next three functions</span>
<a name="l00019"></a>00019 }
<a name="l00020"></a>00020 <span class="keywordtype">bool</span> receiverStatusIsWarning(uint32_t receiverStatus){
<a name="l00021"></a>00021 <span class="keywordflow">return</span> 0 != (receiverStatus & 0xe1fc000e);
<a name="l00022"></a>00022 }
<a name="l00023"></a>00023 <span class="keywordtype">bool</span> receiverStatusIsError(uint32_t receiverStatus){
<a name="l00024"></a>00024 <span class="keywordflow">return</span> 0 != (receiverStatus & 0x00028fe0);
<a name="l00025"></a>00025 }
<a name="l00026"></a>00026 <span class="keywordtype">bool</span> receiverStatusIsFatal(uint32_t receiverStatus){
<a name="l00027"></a>00027 <span class="keywordflow">return</span> 0 != (receiverStatus & 0x00000001);
<a name="l00028"></a>00028 }
<a name="l00029"></a>00029 <span class="keywordtype">bool</span> receiverStatusIsReservedValue(uint32_t receiverStatus){
<a name="l00030"></a>00030 <span class="keywordflow">return</span> 0 != (receiverStatus & 0x1e017010); <span class="comment">// quick cross-check: this magic value, summed with the one from receiverStatusIsGood() should yield 0xffffffff</span>
<a name="l00031"></a>00031 }
<a name="l00032"></a>00032 std::string receiverStatusToString(uint32_t receiverStatus){
<a name="l00033"></a>00033 std::stringstream ss;
<a name="l00034"></a>00034 ss << <span class="stringliteral">"Error flag: "</span>
<a name="l00035"></a>00035 << ((0 == (receiverStatus & 0x00000001)) ? <span class="stringliteral">"No error"</span> : <span class="stringliteral">"Error"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// unrecoverable --> exception</span>
<a name="l00036"></a>00036 ss << <span class="stringliteral">"Temperature status: "</span>
<a name="l00037"></a>00037 << ((0 == (receiverStatus & 0x00000002)) ? <span class="stringliteral">"Within specifications"</span> : <span class="stringliteral">"Warning"</span>) << <span class="stringliteral">"; "</span>;<span class="comment">// warning (error?)</span>
<a name="l00038"></a>00038 ss << <span class="stringliteral">"Voltage supply status: "</span>
<a name="l00039"></a>00039 << ((0 == (receiverStatus & 0x00000004)) ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Warning"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// warning (error?)</span>
<a name="l00040"></a>00040 ss << <span class="stringliteral">"Antenna power status: "</span>
<a name="l00041"></a>00041 << ((0 == (receiverStatus & 0x00000008)) ? <span class="stringliteral">"Powered"</span> : <span class="stringliteral">"Not powered"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// warning (are there unpowered antennas??)</span>
<a name="l00042"></a>00042 ss << <span class="stringliteral">"Antenna open flag: "</span>
<a name="l00043"></a>00043 << ((0 == (receiverStatus & 0x00000020)) ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Open"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error</span>
<a name="l00044"></a>00044 ss << <span class="stringliteral">"Antenna shorted flag: "</span>
<a name="l00045"></a>00045 << ((0 == (receiverStatus & 0x00000040)) ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Shorted"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error</span>
<a name="l00046"></a>00046 ss << <span class="stringliteral">"CPU overload flag: "</span>
<a name="l00047"></a>00047 << ((0 == (receiverStatus & 0x00000080)) ? <span class="stringliteral">"No overload"</span> : <span class="stringliteral">"Overload"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error (recoverable? warning?)</span>
<a name="l00048"></a>00048 ss << <span class="stringliteral">"COM1 buffer overrun flag: "</span>
<a name="l00049"></a>00049 << ((0 == (receiverStatus & 0x00000100)) ? <span class="stringliteral">"No overrun"</span> : <span class="stringliteral">"Overrun"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error (recoverable? warning?)</span>
<a name="l00050"></a>00050 ss << <span class="stringliteral">"COM2 buffer overrun flag: "</span>
<a name="l00051"></a>00051 << ((0 == (receiverStatus & 0x00000200)) ? <span class="stringliteral">"No overrun"</span> : <span class="stringliteral">"Overrun"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error (recoverable? warning?)</span>
<a name="l00052"></a>00052 ss << <span class="stringliteral">"COM3 buffer overrun flag: "</span>
<a name="l00053"></a>00053 << ((0 == (receiverStatus & 0x00000400)) ? <span class="stringliteral">"No overrun"</span> : <span class="stringliteral">"Overrun"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error (recoverable? warning?)</span>
<a name="l00054"></a>00054 ss << <span class="stringliteral">"USB buffer overrun flag: "</span>
<a name="l00055"></a>00055 << ((0 == (receiverStatus & 0x00000800)) ? <span class="stringliteral">"No overrun"</span> : <span class="stringliteral">"Overrun"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error (recoverable? warning?)</span>
<a name="l00056"></a>00056 ss << <span class="stringliteral">"RF1 AGC status: "</span>
<a name="l00057"></a>00057 << ((0 == (receiverStatus & 0x00008000)) ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Bad"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error</span>
<a name="l00058"></a>00058 ss << <span class="stringliteral">"RF2 AGC status: "</span>
<a name="l00059"></a>00059 << ((0 == (receiverStatus & 0x00020000)) ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Bad"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">// error</span>
<a name="l00060"></a>00060 ss << <span class="stringliteral">"Almanac flag/UTC known: "</span>
<a name="l00061"></a>00061 << ((0 == (receiverStatus & 0x00040000)) ? <span class="stringliteral">"Valid"</span> : <span class="stringliteral">"Invalid"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00062"></a>00062 ss << <span class="stringliteral">"Position solution flag: "</span>
<a name="l00063"></a>00063 << ((0 == (receiverStatus & 0x00080000)) ? <span class="stringliteral">"Valid"</span> : <span class="stringliteral">"Invalid"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00064"></a>00064 ss << <span class="stringliteral">"Position fixed flag: "</span>
<a name="l00065"></a>00065 << ((0 == (receiverStatus & 0x00100000)) ? <span class="stringliteral">"Not"</span> : <span class="stringliteral">"fixed Fixed"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00066"></a>00066 ss << <span class="stringliteral">"Clock steering status: "</span>
<a name="l00067"></a>00067 << ((0 == (receiverStatus & 0x00200000)) ? <span class="stringliteral">"Enabled"</span> : <span class="stringliteral">"Disabled"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00068"></a>00068 ss << <span class="stringliteral">"Clock model flag: "</span>
<a name="l00069"></a>00069 << ((0 == (receiverStatus & 0x00400000)) ? <span class="stringliteral">"Valid"</span> : <span class="stringliteral">"Invalid"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00070"></a>00070 ss << <span class="stringliteral">"OEMV card external oscillator flag: "</span>
<a name="l00071"></a>00071 << ((0 == (receiverStatus & 0x00800000)) ? <span class="stringliteral">"Disabled"</span> : <span class="stringliteral">"Enabled"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning (is this really a warning??)</span>
<a name="l00072"></a>00072 ss << <span class="stringliteral">"Software resource: "</span>
<a name="l00073"></a>00073 << ((0 == (receiverStatus & 0x01000000)) ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Warning"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning (error?)</span>
<a name="l00074"></a>00074 ss << <span class="stringliteral">"Auxiliary 3 status event flag: "</span>
<a name="l00075"></a>00075 << ((0 == (receiverStatus & 0x20000000)) ? <span class="stringliteral">"No event"</span> : <span class="stringliteral">"Event"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00076"></a>00076 ss << <span class="stringliteral">"Auxiliary 2 status event flag: "</span>
<a name="l00077"></a>00077 << ((0 == (receiverStatus & 0x40000000)) ? <span class="stringliteral">"No event"</span> : <span class="stringliteral">"Event"</span>) << <span class="stringliteral">"; "</span>; <span class="comment">//warning</span>
<a name="l00078"></a>00078 ss << <span class="stringliteral">"Auxiliary 1 status event flag: "</span>
<a name="l00079"></a>00079 << ((0 == (receiverStatus & 0x80000000)) ? <span class="stringliteral">"No event"</span> : <span class="stringliteral">"Event"</span>); <span class="comment">//warning</span>
<a name="l00080"></a>00080 <span class="keywordflow">return</span> ss.str();
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 }<span class="comment">//namespace</span>
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="preprocessor">#endif</span>
</pre></div></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>
