Orocos Real-Time Toolkit
2.6.0
|
A class representing a switch which can be on or off. More...
#include <rtt/extras/dev/DigitalInput.hpp>
Public Member Functions | |
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. | |
DigitalInput (const bool &value, bool invert=false) | |
Create an object to read the state of a boolean value which can be on or off. | |
~DigitalInput () | |
Destruct the DigitalInput. | |
bool | isOn () const |
Status. |
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 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 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 DigitalInput.hpp.
bool RTT::dev::DigitalInput::isOn | ( | ) | const [inline] |