Diff: Map.hpp

Revision:

0:0dd4a69da379

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Map.hpp	Sat Dec 05 06:19:45 2020 +0000
@@ -0,0 +1,34 @@
+#ifndef MAP_H
+#define MAP_H
+
+#include "mbed.h"
+
+/**
+ *  A library that maps one range (inMin -> inMax) to another (outMin -> outMax)
+ *
+ * @author CA Bezuidenhout
+ */
+class Map
+{
+public:
+  /**
+   * @param inMin : Minimum value of input range
+   * @param inMax : Maximum value of input range
+   * @param outMin : Minimum value of output range
+   * @param outMax : Maximum value of output range
+   */
+  Map(int inMin, int inMax, int outMin, int outMax);
+
+  /**
+   * Map inVal onto the output range
+   *
+   * @param inVal : A value in the input range to be mapped onto the output range
+   * @returns A value in the output range
+   */
+  int Calculate(int inVal);
+private:
+  int _inMin,_inMax;
+  int _outMin,_outMax;
+
+};
+#endif
\ No newline at end of file