Index: group__tokenring.html
===================================================================
--- group__tokenring.html (revision 191)
+++ group__tokenring.html (revision 192)
@@ -31,9 +31,6 @@
void | wl_token_ring_leave (void) |
| Leave the token ring.
|
-void | wl_token_request (int robot) |
-
- | Request a BOM flash from the specified robot.
|
int | wl_token_get_robots_in_ring (void) |
| Return the number of robots in the token ring.
|
@@ -55,19 +52,49 @@
int | wl_token_get_my_sensor_reading (int dest) |
| Return the latest BOM reading between us and another robot.
|
-
-int | wl_token_get_num_robots (void) |
+int | wl_token_get_num_robots (void) |
- | Return the number of robots in the sensor matrix.
|
-
-int | wl_token_get_matrix_size (void) |
+ | Return the number of robots in the sensor matrix.
|
+int | wl_token_get_matrix_size (void) |
- | Return the number of non-null elements in the sensor matrix.
|
+ | Return the number of non-null elements in the sensor matrix.
|
Detailed Description
Wireless library token ring implementation.
This packet group is used to form a token ring, which keeps track of the relative directions of the robots from one another.
Function Documentation
+
+
+
+
+
+
+ int wl_token_get_matrix_size |
+ ( |
+ void |
+ |
+ ) |
+ |
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+
+Return the number of non-null elements in the sensor matrix.
+
+Returns the number of robots in the sensor matrix.
+ - Returns:
- the number of robots in the sensor matrix
+ |
+
+
+
+
+
+
+
+
+ int wl_token_get_num_robots |
+ ( |
+ void |
+ |
+ ) |
+ |
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+
+Return the number of robots in the sensor matrix.
+
+Returns the number of robots currently in the token ring.
+ - Returns:
- the number of robots in the token ring
+ |
+
+
-
-
-
-
-
-
- void wl_token_request |
- ( |
- int |
- robot |
- ) |
- |
-
-
- |
-
-
-
-
-
-
- |
-
-
-
-Request a BOM flash from the specified robot.
-
-Requests that the specified robot be given the token and allowed to flash its BOM. After its BOM is flashed, the token will return to the robot who sent it.
- - Parameters:
-
-
- | robot | the ID of the robot which should flash its BOM |
-
-
- |
-
-
@@ -528,7 +551,7 @@
Removes the packet group from the wireless library.
-
Generated on Mon Sep 24 14:12:31 2007 for libwireless by
+
Generated on Wed Oct 31 17:54:43 2007 for libwireless by
1.4.6