Represents a digital input device. More...

#include <DigitalInput.h>

Inheritance diagram for rec::robotino::api2::DigitalInput:

Public Member Functions
void	setComId (const ComId &id)

void	processEvents ()

void	setInputNumber (unsigned int n)

bool	value () const

virtual void	valueChangedEvent (bool value)

Public Member Functions inherited from rec::robotino::api2::ComObject
	ComObject ()

virtual	~ComObject ()

ComId	comId () const

Static Public Member Functions
static unsigned int	numDigitalInputs ()

Friends
class	DigitalInputImpl

Additional Inherited Members
Protected Attributes inherited from rec::robotino::api2::ComObject
ComId	_comID

Detailed Description

Represents a digital input device.

Member Function Documentation

static unsigned int rec::robotino::api2::DigitalInput::numDigitalInputs ( )

static

Returns: Returns the number of digital inputs

Exceptions

nothing

void rec::robotino::api2::DigitalInput::processEvents ( )

Call this function from your main thread to get the virtual DigitalInput functions called. The virtual functions are called directly by a call of this function

Exceptions

nothing

See also: Com::processEvents

void rec::robotino::api2::DigitalInput::setComId ( const ComId & id )

Sets the associated communication object.

Parameters

id	The id of the associated communication object.

Exceptions

RobotinoException If the given communication object doesn't provide a camera.

void rec::robotino::api2::DigitalInput::setInputNumber ( unsigned int n )

Sets the number of this digital input device.

Parameters

n	The input number. Range [0; Robotstate::numDigitalInputs-1]

Exceptions

RobotinoException if the given input number is invalid.

bool rec::robotino::api2::DigitalInput::value ( ) const

Returns the current value of the specified input device.

Returns: The current value of the specified digital input

Exceptions

RobotinoException if the underlying communication object is invalid

See also: setInputNumber(), ComObject::setComId

virtual void rec::robotino::api2::DigitalInput::valueChangedEvent ( bool value )

virtual

Called when value changed

Parameters

value The current value

Exceptions

nothing.

Remarks: This function is called from the thread in which Com::processEvents() is called.

See also: Com::processEvents

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

C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/DigitalInput.h

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation