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

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

Typedefs

typedef int InfoId

Functions

DLLEXPORT InfoId Info_construct ()
DLLEXPORT BOOL Info_destroy (InfoId id)
DLLEXPORT BOOL Info_setComId (InfoId id, ComId comId)
DLLEXPORT BOOL Info_text (InfoId id, char *infoBuffer, unsigned int infoBuffersSize)
DLLEXPORT BOOL Info_isPassiveMode (InfoId id)


Detailed Description

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

Use Info_construct() to create a new info object. Associate the info object with a com object using Info_setComId(). Use Info_text() to read the info message. Use Info_isPassiveMode() to check for passive mode connection.


Function Documentation

DLLEXPORT InfoId Info_construct (  ) 

Construct an info object

Returns:
Returns the ID of the newly constructed info object.

DLLEXPORT BOOL Info_destroy ( InfoId  id  ) 

Destroy the info object assigned to id

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

DLLEXPORT BOOL Info_isPassiveMode ( InfoId  id  ) 

Returns wether this device is in passive mode.

Parameters:
id The id of the info object to be read
Returns:
TRUE if in passive mode, FALSE otherwise.

DLLEXPORT BOOL Info_setComId ( InfoId  id,
ComId  comId 
)

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

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

DLLEXPORT BOOL Info_text ( InfoId  id,
char *  infoBuffer,
unsigned int  infoBuffersSize 
)

Gets the current text message of this device.

Parameters:
infoBuffer Will contain the received into message as '' terminated string.
infoBuffersSize The size of infoBuffer.
Returns:
Returns TRUE (1) on success. Returns FALSE (0) if the given InfoId is invalid or if infoBuffer is to small to contain the info message string.


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