Diff: Actuators/StepperMotor.h

Revision:

3:b1bb477e115e

Parent:

1:a7810e7acf8d

--- a/Actuators/StepperMotor.h	Tue Nov 29 17:43:48 2016 +0000
+++ b/Actuators/StepperMotor.h	Fri Mar 10 10:50:53 2017 +0100
@@ -45,21 +45,21 @@
 
 /* Includes ------------------------------------------------------------------*/
 
-#include <ComponentObject.h>
+#include <Component.h>
 
 
 /* Classes  ------------------------------------------------------------------*/
 
-/** An abstract class for StepperMotor components.
+/**
+ * An abstract class for StepperMotor components.
  */
-class StepperMotor : public ComponentObject
-{
+class StepperMotor : public Component {
 public:
+
     /**
      * @brief Rotation modes.
      */
-    typedef enum
-    {
+    typedef enum {
         BWD = 0, /* Backward. */
         FWD = 1  /* Forward. */
     } direction_t;
@@ -67,8 +67,7 @@
     /**
      * @brief Step modes.
      */
-    typedef enum
-    {
+    typedef enum {
         STEP_MODE_FULL = 0, /* Full-step. */
         STEP_MODE_HALF,     /* Half-step. */
         STEP_MODE_1_4,      /* 1/4 microstep. */
@@ -87,140 +86,140 @@
      * @param  None.
      * @retval The status.
      */
-    virtual unsigned int GetStatus(void) = 0;
+    virtual unsigned int get_status(void) = 0;
 
     /**
      * @brief  Getting the position.
      * @param  None.
      * @retval The position.
      */
-    virtual signed int GetPosition(void) = 0;
+    virtual signed int get_position(void) = 0;
 
     /**
      * @brief  Getting the marked position.
      * @param  None.
      * @retval The marked position.
      */
-    virtual signed int GetMark(void) = 0;
+    virtual signed int get_mark(void) = 0;
 
     /**
      * @brief  Getting the current speed in pps.
      * @param  None.
      * @retval The current speed in pps.
      */
-    virtual unsigned int GetSpeed(void) = 0;
+    virtual unsigned int get_speed(void) = 0;
 
     /**
      * @brief  Getting the maximum speed in pps.
      * @param  None.
      * @retval The maximum speed in pps.
      */
-    virtual unsigned int GetMaxSpeed(void) = 0;
+    virtual unsigned int get_max_speed(void) = 0;
 
     /**
      * @brief  Getting the minimum speed in pps.
      * @param  None.
      * @retval The minimum speed in pps.
      */
-    virtual unsigned int GetMinSpeed(void) = 0;
+    virtual unsigned int get_min_speed(void) = 0;
 
     /**
      * @brief  Getting the acceleration in pps^2.
      * @param  None.
      * @retval The acceleration in pps^2.
      */
-    virtual unsigned int GetAcceleration(void) = 0;
+    virtual unsigned int get_acceleration(void) = 0;
 
     /**
      * @brief  Getting the deceleration in pps^2.
      * @param  None.
      * @retval The deceleration in pps^2.
      */
-    virtual unsigned int GetDeceleration(void) = 0;
+    virtual unsigned int get_deceleration(void) = 0;
 
     /**
      * @brief  Getting the direction of rotation.
      * @param  None.
      * @retval The direction of rotation.
      */
-    virtual direction_t GetDirection(void) = 0;
+    virtual direction_t get_direction(void) = 0;
 
     /**
      * @brief  Setting the current position to be the home position.
      * @param  None.
      * @retval None.
      */
-    virtual void SetHome(void) = 0;
+    virtual void set_home(void) = 0;
 
     /**
      * @brief  Setting the current position to be the marked position.
      * @param  None.
      * @retval None.
      */
-    virtual void SetMark(void) = 0;
+    virtual void set_mark(void) = 0;
 
     /**
      * @brief  Setting the maximum speed in pps.
      * @param  speed The maximum speed in pps.
      * @retval "true" in case of success, "false" otherwise.
      */
-    virtual bool SetMaxSpeed(unsigned int speed) = 0;
+    virtual bool set_max_speed(unsigned int speed) = 0;
 
     /**
      * @brief  Setting the minimum speed in pps.
      * @param  speed The minimum speed in pps.
      * @retval "true" in case of success, "false" otherwise.
      */
-    virtual bool SetMinSpeed(unsigned int speed) = 0;
+    virtual bool set_min_speed(unsigned int speed) = 0;
 
     /**
      * @brief  Setting the acceleration in pps^2.
      * @param  acceleration The acceleration in pps^2.
      * @retval "true" in case of success, "false" otherwise.
      */
-    virtual bool SetAcceleration(unsigned int acceleration) = 0;
+    virtual bool set_acceleration(unsigned int acceleration) = 0;
 
     /**
      * @brief  Setting the deceleration in pps^2.
      * @param  deceleration The deceleration in pps^2.
      * @retval "true" in case of success, "false" otherwise.
      */
-    virtual bool SetDeceleration(unsigned int deceleration) = 0;
+    virtual bool set_deceleration(unsigned int deceleration) = 0;
 
     /**
      * @brief  Setting the Step Mode.
      * @param  step_mode The Step Mode.
      * @retval "true" in case of success, "false" otherwise.
      */
-    virtual bool SetStepMode(step_mode_t step_mode) = 0;
+    virtual bool set_step_mode(step_mode_t step_mode) = 0;
 
     /**
      * @brief  Going to a specified position.
      * @param  position The desired position.
      * @retval None.
      */
-    virtual void GoTo(signed int position) = 0;
+    virtual void go_to(signed int position) = 0;
 
     /**
      * @brief  Going to the home position.
      * @param  None.
      * @retval None.
      */
-    virtual void GoHome(void) = 0;
+    virtual void go_home(void) = 0;
 
     /**
      * @brief  Going to the marked position.
      * @param  None.
      * @retval None.
      */
-    virtual void GoMark(void) = 0;
+    virtual void go_mark(void) = 0;
 
     /**
      * @brief  Running the motor towards a specified direction.
      * @param  direction The direction of rotation.
      * @retval None.
      */
-    virtual void Run(direction_t direction) = 0;
+    virtual void run(direction_t direction) = 0;
 
     /**
      * @brief  Moving the motor towards a specified direction for a certain number of steps.
@@ -228,42 +227,47 @@
      * @param  steps The desired number of steps.
      * @retval None.
      */
-    virtual void Move(direction_t direction, unsigned int steps) = 0;
+    virtual void move(direction_t direction, unsigned int steps) = 0;
 
     /**
      * @brief  Stopping the motor through an immediate deceleration up to zero speed.
      * @param  None.
      * @retval None.
      */
-    virtual void SoftStop(void) = 0;
+    virtual void soft_stop(void) = 0;
 
     /**
      * @brief  Stopping the motor through an immediate infinite deceleration.
      * @param  None.
      * @retval None.
      */
-    virtual void HardStop(void) = 0;
+    virtual void hard_stop(void) = 0;
 
     /**
      * @brief  Disabling the power bridge after performing a deceleration to zero.
      * @param  None.
      * @retval None.
      */
-    virtual void SoftHiZ(void) = 0;
+    virtual void soft_hiz(void) = 0;
 
     /**
      * @brief  Disabling the power bridge immediately.
      * @param  None.
      * @retval None.
      */
-    virtual void HardHiZ(void) = 0;
+    virtual void hard_hiz(void) = 0;
 
     /**
      * @brief  Waiting while the motor is active.
      * @param  None.
      * @retval None.
      */
-    virtual void WaitWhileActive(void) = 0;
+    virtual void wait_while_active(void) = 0;
+
+    /**
+     * @brief Destructor.
+     */
+    virtual ~StepperMotor() {};
 };
 
 #endif /* __STEPPERMOTOR_CLASS_H */