#include <DigitalInput.hpp>
Public Member Functions | |
| DigitalInput (const bool &value, bool invert=false) | |
| DigitalInput (DigitalInInterface *dig_in, unsigned int bit_nr, bool invert=false) | |
| DigitalInput (const bool &value, bool invert=false) | |
| DigitalInput (DigitalInInterface *dig_in, unsigned int bit_nr, bool invert=false) | |
| bool | isOn () const |
| bool | isOn () const |
| ~DigitalInput () | |
| ~DigitalInput () | |
Private Attributes | |
| int | bitnumber |
| DigitalInInterface * | board |
| bool | minvert |
| const bool & | mvalue |
A class representing a switch which can be on or off. This class can be used in combination with a DigitalInInterface or as a 'virtual' switch in which case the on/off state is stored in an external boolean variable supplied to the constructor.
Definition at line 54 of file install/include/rtt/extras/dev/DigitalInput.hpp.
| RTT::dev::DigitalInput::DigitalInput | ( | DigitalInInterface * | dig_in, | |
| unsigned int | bit_nr, | |||
| bool | invert = false | |||
| ) | [inline] |
Create an object to read the state of a switch which can be on or off.
| dig_in | The digital input device to use to read the status. | |
| bit_nr | The bit number to use on the device. | |
| invert | Set to true to return the inverted bit in isOn(). |
Definition at line 65 of file install/include/rtt/extras/dev/DigitalInput.hpp.
| RTT::dev::DigitalInput::DigitalInput | ( | const bool & | value, | |
| bool | invert = false | |||
| ) | [inline] |
Create an object to read the state of a boolean value which can be on or off.
| value | A reference to a boolean representing a digital input and which is used to read the status. | |
| invert | Set to true to return the inverted value in isOn(). |
Definition at line 78 of file install/include/rtt/extras/dev/DigitalInput.hpp.
| RTT::dev::DigitalInput::~DigitalInput | ( | ) | [inline] |
Destruct the DigitalInput.
Definition at line 86 of file install/include/rtt/extras/dev/DigitalInput.hpp.
| RTT::dev::DigitalInput::DigitalInput | ( | DigitalInInterface * | dig_in, | |
| unsigned int | bit_nr, | |||
| bool | invert = false | |||
| ) | [inline] |
Create an object to read the state of a switch which can be on or off.
| dig_in | The digital input device to use to read the status. | |
| bit_nr | The bit number to use on the device. | |
| invert | Set to true to return the inverted bit in isOn(). |
Definition at line 65 of file rtt/extras/dev/DigitalInput.hpp.
| RTT::dev::DigitalInput::DigitalInput | ( | const bool & | value, | |
| bool | invert = false | |||
| ) | [inline] |
Create an object to read the state of a boolean value which can be on or off.
| value | A reference to a boolean representing a digital input and which is used to read the status. | |
| invert | Set to true to return the inverted value in isOn(). |
Definition at line 78 of file rtt/extras/dev/DigitalInput.hpp.
| RTT::dev::DigitalInput::~DigitalInput | ( | ) | [inline] |
Destruct the DigitalInput.
Definition at line 86 of file rtt/extras/dev/DigitalInput.hpp.
| bool RTT::dev::DigitalInput::isOn | ( | ) | const [inline] |
Status.
Definition at line 93 of file rtt/extras/dev/DigitalInput.hpp.
| bool RTT::dev::DigitalInput::isOn | ( | ) | const [inline] |
Status.
Definition at line 93 of file install/include/rtt/extras/dev/DigitalInput.hpp.
int RTT::dev::DigitalInput::bitnumber [private] |
Definition at line 101 of file install/include/rtt/extras/dev/DigitalInput.hpp.
DigitalInInterface * RTT::dev::DigitalInput::board [private] |
Definition at line 100 of file install/include/rtt/extras/dev/DigitalInput.hpp.
bool RTT::dev::DigitalInput::minvert [private] |
Definition at line 102 of file install/include/rtt/extras/dev/DigitalInput.hpp.
const bool & RTT::dev::DigitalInput::mvalue [private] |
Definition at line 103 of file install/include/rtt/extras/dev/DigitalInput.hpp.
