DigitalInput.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Mon Jan 19 14:11:20 CET 2004  DigitalInput.hpp
00003 
00004                         DigitalInput.hpp -  description
00005                            -------------------
00006     begin                : Mon January 19 2004
00007     copyright            : (C) 2004 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.ac.be
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 #ifndef DIGITALINPUT_HPP
00039 #define DIGITALINPUT_HPP
00040 
00041 #include "DigitalInInterface.hpp"
00042 
00043 namespace RTT
00044 {
00053     class RTT_API DigitalInput
00054     {
00055     public:
00064         DigitalInput( DigitalInInterface* dig_in, unsigned int bit_nr, bool invert = false )
00065             :board(dig_in), bitnumber(bit_nr) , minvert(invert), mvalue(invert)
00066         {
00067         }
00068 
00077         DigitalInput( const bool& value, bool invert = false )
00078             :board(0), bitnumber(0), minvert(invert), mvalue(value)
00079         {
00080         }
00081 
00085         ~DigitalInput() {};
00086 
00092         bool isOn() const
00093         {
00094             // Q: who knew that != is logical xor ?
00095             return board ? minvert != board->isOn(bitnumber) : minvert != mvalue;
00096         }
00097 
00098     private:
00099         DigitalInInterface *board;
00100         int bitnumber;
00101         bool minvert;
00102         const bool& mvalue;
00103     };
00104 }
00105 
00106 #endif // DIGITALINPUT_HPP
Generated on Thu Dec 23 13:22:37 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3