Diff: ak09970ctrl.h

Revision:

34:1ea3357c8d9a

Parent:

29:b488d2c89fba

Parent:

23:50c98b286e41

Child:

39:3821886c902e

diff -r 5a241d9b3262 -r 1ea3357c8d9a ak09970ctrl.h
--- a/ak09970ctrl.h	Fri Apr 28 20:32:31 2017 +0000
+++ b/ak09970ctrl.h	Wed May 03 18:00:45 2017 +0000
@@ -6,6 +6,9 @@
 #include "akmsensor.h"
 #include "ak09970.h"
 
+/**
+ * Class for handling commands issued to the AK09970.
+ */
 class Ak09970Ctrl : public AkmSensor
 {
 
@@ -13,9 +16,11 @@
     
     typedef AkmSensor base;
 
-    // SUB ID
-    typedef enum {                           // 5bit ID
-        SUB_ID_AK09970              = 0x03,  // 3
+    /** 
+     * Device Sub-ID (5-bit ID).
+     */
+    typedef enum {
+        SUB_ID_AK09970              = 0x03,  /**< AK09970: ID = 03h */
     } SubIdSwitch;
     
     /**
@@ -29,12 +34,58 @@
      *
      */
     virtual ~Ak09970Ctrl();
+    
+    /**
+     * Process for intializing the selected sensor.
+     *
+     * @return Termination status type for debugging purposes.
+     */
     virtual AkmSensor::Status init(const uint8_t id, const uint8_t subid);
+    
+    /**
+     * Process abstraction for starting sensor operation.
+     *
+     * @return Termination status type for debugging purposes.
+     */
     virtual AkmSensor::Status startSensor();
+    
+    /**
+     * Process abstraction for starting sensor operation.
+     *
+     * @param sec Number of seconds of operation.
+     * @return Termination status type for debugging purposes.
+     */
     virtual AkmSensor::Status startSensor(const float sec);
+    
+    /**
+     * Process abstraction for stopping sensor operation.
+     *
+     * @return Termination status type for debugging purposes.
+     */
     virtual AkmSensor::Status stopSensor();
+    
+    /**
+     * Process abstraction for reading data from the sensor.
+     *
+     * @param msg Message object that will hold the sensor data.
+     * @return Termination status type for debugging purposes.
+     */
     virtual AkmSensor::Status readSensorData(Message* msg);
+    
+    /**
+     * Primary process for interfacing a sensor with the AKDP.  When implemented
+     * in sensor class, it will transfer commands between the the sensor control
+     * class and AkmSensorManager. 
+     *
+     * @param in Command message to be processed by sensor.
+     * @param out Message returned from sensor.
+     * @return Termination status type for debugging purposes.
+     */
     virtual AkmSensor::Status requestCommand(Message* in, Message* out);
+       
+    /**
+     * Set event flag.
+     */
     virtual void setEvent();
     
 private: