Orocos Real-Time Toolkit  2.9.0
Public Member Functions | Static Public Attributes | List of all members
RTT::dev::DigitalInInterface Class Referenceabstract

A class representing a Digital Input device from which a maximum of 32 bits can be read at once. More...

#include <rtt/extras/dev/DigitalInInterface.hpp>

Inheritance diagram for RTT::dev::DigitalInInterface:
RTT::dev::NameServerRegistrator< DigitalInInterface * >

Public Member Functions

 DigitalInInterface (const std::string &name)
 Construct a nameserved DigitalInInterface instance. More...
 
 DigitalInInterface ()
 Create a not nameserved DigitalInInterface instance. More...
 
virtual ~DigitalInInterface ()
 
virtual bool isOn (unsigned int bit=0) const =0
 Inspect if a certain bit is on. More...
 
virtual bool isOff (unsigned int bit=0) const =0
 Inspect if a certain bit is on. More...
 
virtual bool readBit (unsigned int bit=0) const =0
 Inspect a bit. More...
 
virtual unsigned int readSequence (unsigned int start_bit, unsigned int stop_bit) const =0
 Inspect a sequence of bits. More...
 
virtual unsigned int nbOfInputs () const =0
 Returns the number of bits that can be read for digital input. More...
 

Static Public Attributes

static NameServer< DigitalInInterface * > nameserver
 The NameServer of this interface. More...
 

Detailed Description

A class representing a Digital Input device from which a maximum of 32 bits can be read at once.

When there are N bits, the bits are numbered from Zero to N-1.

See also
TemplateDigitalIn

Definition at line 56 of file DigitalInInterface.hpp.

Constructor & Destructor Documentation

RTT::dev::DigitalInInterface::DigitalInInterface ( const std::string &  name)
inline

Construct a nameserved DigitalInInterface instance.

The object can then be retrieved using DigitalInInterface::nameserver .

Parameters
nameThe name which will refer to this instance.

Definition at line 67 of file DigitalInInterface.hpp.

RTT::dev::DigitalInInterface::DigitalInInterface ( )
inline

Create a not nameserved DigitalInInterface instance.

Definition at line 75 of file DigitalInInterface.hpp.

virtual RTT::dev::DigitalInInterface::~DigitalInInterface ( )
inlinevirtual

Definition at line 78 of file DigitalInInterface.hpp.

Member Function Documentation

virtual bool RTT::dev::DigitalInInterface::isOff ( unsigned int  bit = 0) const
pure virtual

Inspect if a certain bit is on.

Parameters
bitThe bit to check, starting from zero.
Returns
true if the bit is low (0), false otherwise.
virtual bool RTT::dev::DigitalInInterface::isOn ( unsigned int  bit = 0) const
pure virtual

Inspect if a certain bit is on.

Parameters
bitThe bit to check, starting from zero.
Returns
true if the bit is high (1), false otherwise.
virtual unsigned int RTT::dev::DigitalInInterface::nbOfInputs ( ) const
pure virtual

Returns the number of bits that can be read for digital input.

virtual bool RTT::dev::DigitalInInterface::readBit ( unsigned int  bit = 0) const
pure virtual

Inspect a bit.

Parameters
bitThe bit to check, starting from zero.
Returns
true if the bit is high (1), false otherwise.
virtual unsigned int RTT::dev::DigitalInInterface::readSequence ( unsigned int  start_bit,
unsigned int  stop_bit 
) const
pure virtual

Inspect a sequence of bits.

Parameters
start_bitThe first bit to check.
stop_bitThe last bit (inclusive) to check.
Returns
a bit pattern denoting the bit status from start_bit to stop_bit where bit zero equals the value of start_bit.

Member Data Documentation

NameServer< DigitalInInterface * > DigitalInInterface::nameserver
static

The NameServer of this interface.

See also
NameServer

Definition at line 85 of file DigitalInInterface.hpp.


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