/home/ciesla/projects/svn.openrobotino.org/openrobotino1/lib/rec/robotino/com/c/AnalogInput.h File Reference

In "rec/robotino/com/c/AnalogInput.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.

Defines

#define INVALID_ANALOGINPUTID   -1

Typedefs

typedef int AnalogInputId

Functions

DLLEXPORT AnalogInputId AnalogInput_construct (unsigned int n)
DLLEXPORT BOOL AnalogInput_destroy (AnalogInputId id)
DLLEXPORT BOOL AnalogInput_setComId (AnalogInputId id, ComId comId)
DLLEXPORT BOOL AnalogInput_setInputNumber (AnalogInputId id, unsigned int n)
DLLEXPORT unsigned int numAnalogInputs ()
DLLEXPORT float AnalogInput_value (AnalogInputId id)


Detailed Description

In "rec/robotino/com/c/AnalogInput.h" you can find functions for reading Robotino's bumper.

Use AnalogInput_construct() to create a new analog input object. Associate the bumper object with a com object using AnalogInput_setComId(). Use AnalogInput_value() to read the analog input's state.


Function Documentation

DLLEXPORT AnalogInputId AnalogInput_construct ( unsigned int  n  ) 

Construct an analog input object

Returns:
Returns the ID of the newly constructed analog input object.
Parameters:
n The input number. Range [0; numAnalogInputs()-1]

DLLEXPORT BOOL AnalogInput_destroy ( AnalogInputId  id  ) 

Destroy the analog input object assigned to id

Parameters:
id The id of the analog input object to be destroyed
Returns:
Returns TRUE (1) on success. Returns FALSE (0) if the given AnalogInputId is invalid.

DLLEXPORT BOOL AnalogInput_setComId ( AnalogInputId  id,
ComId  comId 
)

Associated a analog input object with a communication interface, i.e. binding the analog input to a specific Robotino

Returns:
Returns TRUE (1) on success. Returns FALSE (0) if the given AnalogInputId or ComId is invalid.

DLLEXPORT BOOL AnalogInput_setInputNumber ( AnalogInputId  id,
unsigned int  n 
)

Sets the number of this analog input device.

Parameters:
id The id of the digital input object to be set
n The input number. Range [0 - numAnalogInputs()]
Exceptions:
Returns TRUE (1) on success otherwise FALSE (0)

DLLEXPORT float AnalogInput_value ( AnalogInputId  id  ) 

Returns the current value of the specified input device.

Parameters:
id The id of the analog input object to be read
Returns:
The current value of the specified analog input. Returns -1 if the given AnalogInputId is invalid or if this analog input is not connected to a valid com object.

DLLEXPORT unsigned int numAnalogInputs (  ) 

Returns:
Returns the number of analog inputs.


Generated on Fri Aug 17 15:09:42 2012 for rec_robotino_com_c by  doxygen 1.5.5