Diff: colour.h

Revision:

13:adbd827234a4

Parent:

12:878c6e9d9e60

--- a/colour.h	Mon Oct 17 13:09:10 2016 +0000
+++ b/colour.h	Mon Oct 17 13:19:20 2016 +0000
@@ -1,11 +1,11 @@
 /* University of York Robotics Laboratory PsiSwarm Library: Colour Sensors Header File
- * 
+ *
  * Copyright 2016 University of York
  *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and limitations under the License.
  *
  * File: colour.h
@@ -18,22 +18,40 @@
  * October 2016
  *
  *
- */ 
+ */
 
 
 #ifndef COLOUR_H
 #define COLOUR_H
 
-/** Set the gain of the base colour sensor
-*
-* @param gain The gain value for the sensor
+/**
+ *  The Colour class contains the functions for reading the base-mounted and top-mounted I2C colour sensors (optional).
 */
-void set_base_colour_sensor_gain(char gain);
+class Colour
+{
+public:
+    /** Set the gain of the base colour sensor
+    *
+    * @param gain The gain value for the sensor
+    */
+    void set_base_colour_sensor_gain(char gain);
 
-void set_base_colour_sensor_integration_time(char int_time);
-void enable_base_colour_sensor(void);
-void read_base_colour_sensor_values(int * store_array);
-char IF_check_base_colour_sensor(void);
+    /** Set the integration time constant for the base colour sensor
+    *
+    * @param gain The gain value for the sensor
+    */
+    void set_base_colour_sensor_integration_time(char int_time);
+
+    /** Enable the base colour sensor
+    */
+    void enable_base_colour_sensor(void);
 
+    /** Read the values from the base colour sensor
+    *
+    * @param Pointer to 3 x int array for r-g-b values
+    */
+    void read_base_colour_sensor_values(int * store_array);
+    char IF_check_base_colour_sensor(void);
 
+};
 #endif
\ No newline at end of file