Colony

/**

 * Copyright (c) 2007 Colony Project

 *

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use,

 * copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following

 * conditions:

 *

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 * OTHER DEALINGS IN THE SOFTWARE.

 **/

/**

 * @file sensor_matrix.h

 * @brief Definitions for sensor matrices

 *

 * Contains functions and declarations for using sensor matrices.

 *

 * @author Brian Coltin, Colony Project, CMU Robotics Club

 **/

#ifndef SENSOR_MATRIX_H

#define SENSOR_MATRIX_H

/**

 * @defgroup sensormatrix Sensor Matrix

 * @brief the robot sensor matrix

 *

 * These functions and structures are used for localization

 * to determine the relative directions of robots.

 *

 * @{

 **/

/**

 * @struct SensorMatrix

 *

 * A sensor matrix.

 **/

//TODO: the order of member variables in this struct should be changed in case the compile packs the struct

// In order to achieve the best packing, the variables should be listed in order of decreasing memory size.

// Thus, pointers should be first, followed by int, followed by char.

typedef struct

{

        /**

         * The size of the sensor matrix.

        **/

        int size;

        /**

         * The matrix. Each row represents the readings of one

         * robot.

         **/

        int** matrix;

        /**

         * The element representing a robot is true if that robot

         * is in the token ring and false otherwise.

         **/

  //TODO: if these values are just to be used to represent boolean values, why are they int?

  // They could be made char and the code should still be fine, and if you want to save more

  // memory, they could be made into bit vectors but that would increase the complexity of

  // the code to set and read from them.

        int* joined;

        /**

         * The number of robots in the token ring.

         **/

  //TODO: int is probably > 2 bytes.  Unless we are going to have more than 255 robots,

  // this could be made a char.  It would only save 1 byte, but on embedded systems, every

  // byte counts

        int numJoined;

} SensorMatrix;

/**@brief Create a sensor matrix **/

SensorMatrix* sensor_matrix_create(void);

/**@brief Destroy a sensor matrix **/

void sensor_matrix_destroy(SensorMatrix* m);

/**@brief Add a robot to a sensor matrix **/

void sensor_matrix_add_robot(SensorMatrix* m, int id);

/**@brief Remove a robot from a sensor matrix **/

void sensor_matrix_remove_robot(SensorMatrix* m, int id);

/**@brief Set a reading in a sensor matrix **/

void sensor_matrix_set_reading(SensorMatrix* m, int observer, int robot, int reading);

/**@brief Get a reading in a sensor matrix **/

int sensor_matrix_get_reading(SensorMatrix* m, int observer, int robot);

/**@brief Set whether the robot is in the token ring **/

void sensor_matrix_set_in_ring(SensorMatrix* m, int robot, int in);

/**@brief Get whether the robot is in the sensor ring **/

int sensor_matrix_get_in_ring(SensorMatrix* m, int robot);

/**@brief Get the size of the sensor matrix **/

int sensor_matrix_get_size(SensorMatrix* m);

/**@brief Get the number of robots which have joined the token ring **/

int sensor_matrix_get_joined(SensorMatrix* m);

/** @} **/ //end defgroup

#endif