src/pin.h

   1 ///
   2 /// \file       pin.h
   3 ///             class for device PIN notation
   4 ///
   5
   6 /*
   7     Copyright (C) 2007-2010, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_PIN_H__
  23 #define __BARRY_PIN_H__
  24
  25 #include "dll.h"
  26 #include <stdint.h>
  27 #include <string>
  28
  29 namespace Barry {
  30
  31 class BXEXPORT Pin
  32 {
  33         uint32_t pin;
  34
  35 public:
  36         Pin(uint32_t pin__ = 0) : pin(pin__) {}
  37
  38         bool Valid() const { return pin != 0; }
  39         void Clear() { pin = 0; }
  40         std::string Str() const;
  41         uint32_t Value() const { return pin; }
  42
  43         Pin& operator=(uint32_t p) { pin = p; return *this; }
  44
  45         bool operator==(uint32_t rhs) const { return pin == rhs; }
  46         bool operator==(const Pin &rhs) const { return pin == rhs.pin; }
  47
  48         bool operator!=(uint32_t rhs) const { return pin != rhs; }
  49         bool operator!=(const Pin &rhs) const { return pin != rhs.pin; }
  50 };
  51
  52 // no ostream operator, since we want to encourage users to call str()...
  53 // but istream may be useful
  54 BXEXPORT std::istream& operator>>(std::istream &is, Pin &pin);
  55
  56 } // namespace Barry
  57
  58 #endif
  59