<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: pin.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- 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="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_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>pin.h</h1><a href="pin_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file pin.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// class for device PIN notation</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2007-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_PIN_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PIN_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <stdint.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <string></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>Barry {
<a name="l00030"></a>00030
<a name="l00031"></a><a class="code" href="classBarry_1_1Pin.html">00031</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Pin.html">Pin</a>
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 uint32_t pin;
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036 <a class="code" href="classBarry_1_1Pin.html">Pin</a>(uint32_t pin__ = 0) : pin(pin__) {}
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keywordtype">bool</span> valid()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pin != 0; }
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keywordtype">void</span> clear() { pin = 0; }
<a name="l00041"></a>00041 std::string str() <span class="keyword">const</span>;
<a name="l00042"></a>00042 uint32_t value()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pin; }
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <a class="code" href="classBarry_1_1Pin.html">Pin</a>& operator=(uint32_t p) { pin = p; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> operator==(uint32_t rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pin == rhs; }
<a name="l00047"></a>00047 <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Pin.html">Pin</a> &rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pin == rhs.pin; }
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keywordtype">bool</span> operator!=(uint32_t rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pin != rhs; }
<a name="l00050"></a>00050 <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Pin.html">Pin</a> &rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pin != rhs.pin; }
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">// no ostream operator, since we want to encourage users to call str()...</span>
<a name="l00054"></a>00054 <span class="comment">// but istream may be useful</span>
<a name="l00055"></a>00055 BXEXPORT std::istream& operator>>(std::istream &is, <a class="code" href="classBarry_1_1Pin.html">Pin</a> &pin);
<a name="l00056"></a>00056
<a name="l00057"></a>00057 } <span class="comment">// namespace Barry</span>
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="preprocessor">#endif</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
