Added iElectromagnet interface
ADD
include/interfaces/iElectromagnet.hpp
+/*
+ * 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;
+
+ };
+}

MODIFY
src/electromagnet/electromagnet.hpp
src/electromagnet/electromagnet.hpp
#pragma once
#include <mraa/gpio.h>
+#include <interfaces/iElectromagnet.hpp>
#define HIGH 1
#define LOW 0
@@ -50,7 +51,7 @@ namespace upm {
* @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;

MODIFY
src/groveelectromagnet/groveelectromagnet.hpp
src/groveelectromagnet/groveelectromagnet.hpp
#pragma once
#include <mraa/gpio.h>
+#include <interfaces/iElectromagnet.hpp>
#define HIGH 1
#define LOW 0
@@ -52,7 +53,7 @@ namespace upm {
* @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;

Added iElectromagnet interface

Signed-off-by: Stefan Andritoiu <stefan.andritoiu@gmail.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>