Public Member Functions | Private Attributes
RTT::dev::DigitalInput Class Reference

#include <DigitalInput.hpp>

List of all members.

Public Member Functions

 DigitalInput (DigitalInInterface *dig_in, unsigned int bit_nr, bool invert=false)
 DigitalInput (const bool &value, bool invert=false)
bool isOn () const
 ~DigitalInput ()

Private Attributes

int bitnumber
DigitalInInterfaceboard
bool minvert
const bool & mvalue

Detailed Description

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.

See also:
also DigitalOutput

Definition at line 54 of file DigitalInput.hpp.


Constructor & Destructor Documentation

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.

Parameters:
dig_inThe digital input device to use to read the status.
bit_nrThe bit number to use on the device.
invertSet 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.

Parameters:
valueA reference to a boolean representing a digital input and which is used to read the status.
invertSet to true to return the inverted value in isOn().

Definition at line 78 of file DigitalInput.hpp.

Destruct the DigitalInput.

Definition at line 86 of file DigitalInput.hpp.


Member Function Documentation

bool RTT::dev::DigitalInput::isOn ( ) const [inline]

Status.

Returns:
true if the input is high.

Definition at line 93 of file DigitalInput.hpp.


Member Data Documentation

Definition at line 101 of file DigitalInput.hpp.

Definition at line 100 of file DigitalInput.hpp.

Definition at line 102 of file DigitalInput.hpp.

const bool& RTT::dev::DigitalInput::mvalue [private]

Definition at line 103 of file DigitalInput.hpp.


The documentation for this class was generated from the following file:


rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:16:23