rec::robotino::api2 C++ interface
Public Member Functions | Static Public Member Functions | Friends | List of all members
rec::robotino::api2::DigitalOutput Class Reference

Represents a digital output device. More...

#include <DigitalOutput.h>

Inheritance diagram for rec::robotino::api2::DigitalOutput:
rec::robotino::api2::ComObject

Public Member Functions

void setComId (const ComId &id)
 
void setOutputNumber (unsigned int n)
 
void setValue (bool on)
 
- Public Member Functions inherited from rec::robotino::api2::ComObject
 ComObject ()
 
virtual ~ComObject ()
 
ComId comId () const
 

Static Public Member Functions

static unsigned int numDigitalOutputs ()
 

Friends

class DigitalOutputImpl
 

Additional Inherited Members

- Protected Attributes inherited from rec::robotino::api2::ComObject
ComId _comID
 

Detailed Description

Represents a digital output device.

Member Function Documentation

static unsigned int rec::robotino::api2::DigitalOutput::numDigitalOutputs ( )
static
Returns
Returns the number of digital outputs
Exceptions
nothing
void rec::robotino::api2::DigitalOutput::setComId ( const ComId id)

Sets the associated communication object.

Parameters
idThe id of the associated communication object.
Exceptions
nothing
Remarks
This function is thread save
void rec::robotino::api2::DigitalOutput::setOutputNumber ( unsigned int  n)

Sets the number of this digital output device.

Parameters
nThe output number. Range [0; Robotstate::numDigitalOutputs-1]
Exceptions
RobotinoExceptionif the given output number is invalid.
void rec::robotino::api2::DigitalOutput::setValue ( bool  on)

Sets the current value of the specified output device.

Parameters
onThe output value of this device.
Exceptions
RobotinoExceptionif the underlying communication object is invalid
See also
setOutputNumber(), ComObject::setComId

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