DigitalOutput.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Mon Jan 19 14:11:20 CET 2004  DigitalOutput.hpp
00003 
00004                         DigitalOutput.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 #ifndef DIGITAL_OUTPUT_HPP
00038 #define DIGITAL_OUTPUT_HPP
00039 
00040 
00041 #include "DigitalOutInterface.hpp"
00042 
00043 namespace RTT
00044 {
00054     class RTT_API DigitalOutput
00055     {
00056     public:
00064         DigitalOutput( DigitalOutInterface* dig_out, unsigned int relay_nr, bool _invert=false )
00065             : board( dig_out ), relaynumber( relay_nr ), invert(_invert)
00066         {}
00067 
00072         DigitalOutput ( bool initial_state = false )
00073             : board( 0 ), relaynumber( 0 ), invert(initial_state)
00074         {}
00075 
00076 
00080         ~DigitalOutput()
00081         {}
00082 
00087         void setBit( bool on_off )
00088         {
00089             if(board)
00090                 board->setBit( relaynumber, on_off != invert );
00091             else
00092                 invert=on_off;
00093         }
00094 
00098         void switchOn()
00099         {
00100             if(board)
00101                 board->setBit( relaynumber, !invert );
00102             else
00103                 invert=true;
00104         }
00105 
00109         void switchOff()
00110         {
00111             if(board)
00112                 board->setBit( relaynumber, invert );
00113             else
00114                 invert=false;
00115         }
00116 
00122         bool isOn() const
00123         {
00124             if(board)
00125                 return invert != board->checkBit( relaynumber );
00126             else
00127                 return invert;
00128         }
00129 
00130     private:
00131         DigitalOutInterface *board;
00132         unsigned int relaynumber;
00133         bool invert;
00134     };
00135 }
00136 
00137 #endif
Generated on Thu Dec 23 13:22:37 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3