Orocos Real-Time Toolkit  2.9.0
DigitalInput.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Mon Jan 19 14:11:20 CET 2004 DigitalInput.hpp
3 
4  DigitalInput.hpp - description
5  -------------------
6  begin : Mon January 19 2004
7  copyright : (C) 2004 Peter Soetens
8  email : peter.soetens@mech.kuleuven.ac.be
9 
10  ***************************************************************************
11  * This library is free software; you can redistribute it and/or *
12  * modify it under the terms of the GNU General Public *
13  * License as published by the Free Software Foundation; *
14  * version 2 of the License. *
15  * *
16  * As a special exception, you may use this file as part of a free *
17  * software library without restriction. Specifically, if other files *
18  * instantiate templates or use macros or inline functions from this *
19  * file, or you compile this file and link it with other files to *
20  * produce an executable, this file does not by itself cause the *
21  * resulting executable to be covered by the GNU General Public *
22  * License. This exception does not however invalidate any other *
23  * reasons why the executable file might be covered by the GNU General *
24  * Public License. *
25  * *
26  * This library is distributed in the hope that it will be useful, *
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
29  * Lesser General Public License for more details. *
30  * *
31  * You should have received a copy of the GNU General Public *
32  * License along with this library; if not, write to the Free Software *
33  * Foundation, Inc., 59 Temple Place, *
34  * Suite 330, Boston, MA 02111-1307 USA *
35  * *
36  ***************************************************************************/
37 
38 #ifndef DIGITALINPUT_HPP
39 #define DIGITALINPUT_HPP
40 
41 #include "DigitalInInterface.hpp"
42 
43 namespace RTT
44 { namespace dev {
45 
55  {
56  public:
65  DigitalInput( DigitalInInterface* dig_in, unsigned int bit_nr, bool invert = false )
66  :board(dig_in), bitnumber(bit_nr) , minvert(invert), mvalue(invert)
67  {
68  }
69 
78  DigitalInput( const bool& value, bool invert = false )
79  :board(0), bitnumber(0), minvert(invert), mvalue(value)
80  {
81  }
82 
87 
93  bool isOn() const
94  {
95  // Q: who knew that != is logical xor ?
96  return board ? minvert != board->isOn(bitnumber) : minvert != mvalue;
97  }
98 
99  private:
100  DigitalInInterface *board;
101  int bitnumber;
102  bool minvert;
103  const bool& mvalue;
104  };
105 }}
106 
107 #endif // DIGITALINPUT_HPP
DigitalInput(const bool &value, bool invert=false)
Create an object to read the state of a boolean value which can be on or off.
A class representing a switch which can be on or off.
#define RTT_API
Definition: rtt-config.h:97
DigitalInput(DigitalInInterface *dig_in, unsigned int bit_nr, bool invert=false)
Create an object to read the state of a switch which can be on or off.
A class representing a Digital Input device from which a maximum of 32 bits can be read at once...
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
bool isOn() const
Status.
~DigitalInput()
Destruct the DigitalInput.