/home/ciesla/projects/svn.openrobotino.org/openrobotino1/lib/rec/robotino/com/c/DigitalOutput.h File Reference
In "rec/robotino/com/c/DigitalOutput.h" you can find functions for reading Robotino's bumper.
More...
#include "rec/robotino/com/c/globals.h"
#include "rec/robotino/com/c/Com.h"
Go to the source code of this file.
Detailed Description
In "rec/robotino/com/c/DigitalOutput.h" you can find functions for reading Robotino's bumper.
Use DigitalOutput_construct() to create a new digital output object. Associate the bumper object with a com object using DigitalOutput_setComId(). Use DigitalOutput_value() to read the digital output's state.
Function Documentation
DLLEXPORT DigitalOutputId DigitalOutput_construct |
( |
unsigned int |
n |
) |
|
Construct an digital output object
- Returns:
- Returns the ID of the newly constructed digital output object.
- Parameters:
-
DLLEXPORT BOOL DigitalOutput_destroy |
( |
DigitalOutputId |
id |
) |
|
Destroy the digital output object assigned to id
- Parameters:
-
| id | The id of the digital output object to be destroyed |
- Returns:
- Returns TRUE (1) on success. Returns FALSE (0) if the given DigitalOutputId is invalid.
DLLEXPORT BOOL DigitalOutput_setComId |
( |
DigitalOutputId |
id, |
|
|
ComId |
comId | |
|
) |
| | |
Associated a digital output object with a communication interface, i.e. binding the digital output to a specific Robotino
- Returns:
- Returns TRUE (1) on success. Returns FALSE (0) if the given DigitalOutputId or ComId is invalid.
DLLEXPORT BOOL DigitalOutput_setOutputNumber |
( |
DigitalOutputId |
id, |
|
|
unsigned int |
n | |
|
) |
| | |
Sets the number of this digital output device.
- Parameters:
-
| id | The id of the digital input object to be set |
| n | The output number. Range [0 - numAnalogInputs()] |
- Exceptions:
-
| Returns | TRUE (1) on success otherwise FALSE (0) |
DLLEXPORT BOOL DigitalOutput_setValue |
( |
DigitalOutputId |
id, |
|
|
BOOL |
on | |
|
) |
| | |
Returns the current value of the specified input device.
- Parameters:
-
| id | The id of the digital output object to be read |
- Returns:
- The current value of the specified digital output
DLLEXPORT unsigned int numDigitalOutputs |
( |
|
) |
|
- Returns:
- Returns the number of digital outputs.