Diff: Components/Interfaces/StepperMotor_class.h

Revision:

7:f7e0c3621f77

Parent:

5:d3c78f12a78d

Child:

8:42e0b00b1e4d

--- a/Components/Interfaces/StepperMotor_class.h	Thu Nov 19 10:56:34 2015 +0000
+++ b/Components/Interfaces/StepperMotor_class.h	Fri Nov 20 18:00:03 2015 +0000
@@ -62,10 +62,18 @@
       FWD = 1  /* Forward. */
     } direction_t;
 
-    /* Get the status. */
+    /**
+     * @brief Getting the status.
+     * @param  None.
+     * @retval None.
+     */
     virtual unsigned int GetStatus(void) = 0;
 
-    /* Get the specified parameter. */
+   /**
+     * @brief  Getting a parameter.
+     * @param  parameter register adress.
+     * @retval a register value.
+     */
     virtual unsigned int GetParameter(unsigned int parameter) = 0;
 
     /* Return the current position. */
@@ -92,7 +100,12 @@
     /* Get the current direction of rotation. */
     virtual direction_t GetDirection(void) = 0;
 
-    /* Set the specified parameter. */
+   /**
+     * @brief  Setting a parameter.
+     * @param  parameter register adress.
+     * @param  value value to be set.
+     * @retval None.
+     */
     virtual void SetParameter(unsigned int parameter, unsigned int value) = 0;
 
     /* Set the current position to be the home position. */
@@ -133,6 +146,9 @@
 
     /* Stop the motor and disable the power bridge. */
     virtual void HardStop(void) = 0;
+
+    /* Wait while the motor is active. */
+    virtual void WaitWhileActive(void) = 0;
 };
 
 #endif /* __STEPPERMOTOR_CLASS_H */