Cornelius Bezuidenhout / Map

A library that maps one range onto another range.

Dependents:   Heiko Simran_Servo_2410 HYDRO-pH-BASIC NucleoBoard_1 ... more

Map.hpp@1:dad975e2e150, 2016-09-28 (annotated)

Committer:
Kerneels Bezuidenhout
Date:
Wed Sep 28 04:02:59 2016 +0200
Revision:
1:dad975e2e150
Parent:
0:f274b178a2d4 
Initial version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kerneels Bezuidenhout 1:dad975e2e150 1 #ifndef MAP_H
Kerneels Bezuidenhout 1:dad975e2e150 2 #define MAP_H
Kerneels Bezuidenhout 1:dad975e2e150 3
Kerneels Bezuidenhout 1:dad975e2e150 4 #include "mbed.h"
Kerneels Bezuidenhout 1:dad975e2e150 5
Kerneels Bezuidenhout 1:dad975e2e150 6 /**
Kerneels Bezuidenhout 1:dad975e2e150 7 * A library that maps one range (inMin -> inMax) to another (outMin -> outMax)
Kerneels Bezuidenhout 1:dad975e2e150 8 *
Kerneels Bezuidenhout 1:dad975e2e150 9 * @author CA Bezuidenhout
Kerneels Bezuidenhout 1:dad975e2e150 10 */
Kerneels Bezuidenhout 1:dad975e2e150 11 class Map
Kerneels Bezuidenhout 1:dad975e2e150 12 {
Kerneels Bezuidenhout 1:dad975e2e150 13 public:
Kerneels Bezuidenhout 1:dad975e2e150 14 /**
Kerneels Bezuidenhout 1:dad975e2e150 15 * @param inMin : Minimum value of input range
Kerneels Bezuidenhout 1:dad975e2e150 16 * @param inMax : Maximum value of input range
Kerneels Bezuidenhout 1:dad975e2e150 17 * @param outMin : Minimum value of output range
Kerneels Bezuidenhout 1:dad975e2e150 18 * @param outMax : Maximum value of output range
Kerneels Bezuidenhout 1:dad975e2e150 19 */
Kerneels Bezuidenhout 1:dad975e2e150 20 Map(float inMin, float inMax, float outMin, float outMax);
Kerneels Bezuidenhout 1:dad975e2e150 21
Kerneels Bezuidenhout 1:dad975e2e150 22 /**
Kerneels Bezuidenhout 1:dad975e2e150 23 * Map inVal onto the output range
Kerneels Bezuidenhout 1:dad975e2e150 24 *
Kerneels Bezuidenhout 1:dad975e2e150 25 * @param inVal : A value in the input range to be mapped onto the output range
Kerneels Bezuidenhout 1:dad975e2e150 26 * @returns A value in the output range
Kerneels Bezuidenhout 1:dad975e2e150 27 */
Kerneels Bezuidenhout 1:dad975e2e150 28 float Calculate(float inVal);
Kerneels Bezuidenhout 1:dad975e2e150 29 private:
Kerneels Bezuidenhout 1:dad975e2e150 30 float _inMin,_inMax;
Kerneels Bezuidenhout 1:dad975e2e150 31 float _outMin,_outMax;
Kerneels Bezuidenhout 1:dad975e2e150 32
Kerneels Bezuidenhout 1:dad975e2e150 33 };
Kerneels Bezuidenhout 1:dad975e2e150 34 #endif