Bumper.h File Reference

In "rec/robotino/api2/c/Bumper.h" you can find functions for reading Robotino's bumper. More...

#include "rec/robotino/api2/c/globals.h"
#include "rec/robotino/api2/c/Com.h"

Go to the source code of this file.

Macros
#define	INVALID_BUMPERID   -1

Typedefs
typedef int	BumperId

Functions
DLLEXPORT BumperId	Bumper_construct ()
DLLEXPORT BOOL	Bumper_destroy (BumperId id)
DLLEXPORT BOOL	Bumper_setComId (BumperId id, ComId comId)
DLLEXPORT BOOL	Bumper_value (BumperId id)
DLLEXPORT int	Bumper_num_objects (void)

Detailed Description

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

Use bumper_construct() to create a new bumper object. Associate the bumper object with a com object using bumper_setComId(). Use bumper_value() to read the bumper's state.

Macro Definition Documentation

#define INVALID_BUMPERID   -1

Invalid BumperId is -1

Typedef Documentation

typedef int BumperId

BumperId

Function Documentation

DLLEXPORT BumperId Bumper_construct

(

)

Construct an Bumper object

Returns

Returns the ID of the newly constructed Bumper object.

DLLEXPORT BOOL Bumper_destroy

(

BumperId

id

)

Destroy the Bumper object assigned to id

Parameters

id	The id of the Bumper object to be destroyed

Returns

Returns TRUE (1) on success. Returns FALSE (0) if the given BumperId is invalid.

DLLEXPORT BOOL Bumper_setComId	(	BumperId	id,
		ComId	comId
	)

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

Returns

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

DLLEXPORT BOOL Bumper_value

(

BumperId

id

)

Get the current state of the bumper.

Parameters

id	The bumper id.

Returns

Returns TRUE (1) if the bumper is pressed. Returns FALSE (0) otherwise.