From b917f0ca54280dec61f699b50906e8715351b0ae Mon Sep 17 00:00:00 2001
From: Stefan Andritoiu <stefan.andritoiu@gmail.com>
Date: Wed, 20 Jun 2018 18:35:30 +0300
Subject: [PATCH] Added iElectromagnet interface

Signed-off-by: Stefan Andritoiu <stefan.andritoiu@gmail.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
---
 include/interfaces/iElectromagnet.hpp         | 47 +++++++++++++++++++
 src/electromagnet/electromagnet.hpp           |  9 ++--
 src/groveelectromagnet/groveelectromagnet.hpp |  9 ++--
 3 files changed, 57 insertions(+), 8 deletions(-)
 create mode 100644 include/interfaces/iElectromagnet.hpp

diff --git a/include/interfaces/iElectromagnet.hpp b/include/interfaces/iElectromagnet.hpp
new file mode 100644
index 00000000..23404dd7
--- /dev/null
+++ b/include/interfaces/iElectromagnet.hpp
@@ -0,0 +1,47 @@
+/*
+ * Author: Mihai Stefanescu <mihai.stefanescu@rinftech.com>
+ * Copyright (c) 2018 Intel Corporation.
+ *
+ * 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.
+ */
+
+#pragma once
+
+namespace upm
+{
+/**
+ * @brief Interface for Electromagnet modules
+*/
+  class iElectromagnet
+  {
+  public:
+    virtual ~iElectromagnet() {}
+
+    /**
+     * Turns the magnet on
+     */
+     virtual void on() = 0;
+    /**
+     * Turns the magnet off
+     */
+     virtual void off() = 0;
+
+  };
+}
diff --git a/src/electromagnet/electromagnet.hpp b/src/electromagnet/electromagnet.hpp
index abd41bfe..85234f04 100644
--- a/src/electromagnet/electromagnet.hpp
+++ b/src/electromagnet/electromagnet.hpp
@@ -24,6 +24,7 @@
 #pragma once
 
 #include <mraa/gpio.h>
+#include <interfaces/iElectromagnet.hpp>
 
 #define HIGH      1
 #define LOW       0
@@ -44,13 +45,13 @@ namespace upm {
    * @con gpio
    *
    * @brief API for the  Electromagnet
-   * 
+   *
    * The  Electromagnet can hold up to 1 kg (approximately 2.2 lbs)
    *
    * @image html electromagnet.jpg
    * @snippet electromagnet.cxx Interesting
    */
-  class Electromagnet {
+  class Electromagnet : virtual public iElectromagnet {
   public:
     /**
      *  Electromagnet constructor
@@ -65,11 +66,11 @@ namespace upm {
     /**
      * Turns the magnet on
      */
-     void on();
+     virtual void on();
     /**
      * Turns the magnet off
      */
-     void off();
+     virtual void off();
 
   private:
         mraa_gpio_context m_gpio;
diff --git a/src/groveelectromagnet/groveelectromagnet.hpp b/src/groveelectromagnet/groveelectromagnet.hpp
index c77402b5..4ab6942f 100644
--- a/src/groveelectromagnet/groveelectromagnet.hpp
+++ b/src/groveelectromagnet/groveelectromagnet.hpp
@@ -24,6 +24,7 @@
 #pragma once
 
 #include <mraa/gpio.h>
+#include <interfaces/iElectromagnet.hpp>
 
 #define HIGH      1
 #define LOW       0
@@ -46,13 +47,13 @@ namespace upm {
    * @con gpio
    *
    * @brief API for the Grove Electromagnet
-   * 
+   *
    * The Grove Electromagnet can hold up to 1 kg (approximately 2.2 lbs)
    *
    * @image html groveelectromagnet.jpg
    * @snippet groveelectromagnet.cxx Interesting
    */
-  class GroveElectromagnet {
+  class GroveElectromagnet : virtual public iElectromagnet {
   public:
     /**
      * Grove Electromagnet constructor
@@ -67,11 +68,11 @@ namespace upm {
     /**
      * Turns the magnet on
      */
-     void on();
+     virtual void on();
     /**
      * Turns the magnet off
      */
-     void off();
+     virtual void off();
 
   private:
         mraa_gpio_context m_gpio;