Webots Reference Manual

previous page go up next page

Thanks

1.Introduction

2.Controller API

3.Webots File Format

     

2.6 Emitter

emitter_get_buffer, emitter_get_buffer_size
emitter_send
emitter_get_channel, emitter_set_channel

emitter_get_buffer

NAME

   emitter_get_buffer, emitter_get_buffer_size -- get information on the emitter buffer

SYNOPSIS

  #include <device/emitter.h>

   gpointer emitter_get_buffer (DeviceTag emitter);
   gint32 emitter_get_buffer_size (DeviceTag emitter);

DESCRIPTION

The emitter_get_buffer function returns a pointer to the buffer used by the emitter to send data. The emitter_get_buffer_size function returns the size of this buffer, expressed in bytes.

emitter_send

NAME

   emitter_send -- send a message through the emitter

SYNOPSIS

  #include <device/emitter.h>

   void emitter_send (DeviceTag emitter, guint32 size);

DESCRIPTION

The emitter_send function sends size bytes of data contained in the beginning of the emitter buffer.

emitter_get_channel

NAME

   emitter_get_channel, emitter_set_channel -- get or set channel information for an emitter.

SYNOPSIS

  #include <device/emitter.h>

   gint32 emitter_get_channel (DeviceTag emitter);
   void emitter_set_channel (DeviceTag emitter, gint32 channel);

DESCRIPTION

The emitter_get_channel function returns the channel value of the Emitter node. Only receivers set to the same channel of the emitter can receive message from this emitter.

The emitter_set_channel function allows the controller to change the emission channel, so that different receivers may receive the messages of the emitter. Calling this function will change the channel field of the Emitter node.

previous page go up next page
^ page top ^

  E-mail to webmaster Last updated: Copyright © 2002 Cyberbotics Ltd.