src/Energia/libraries/ZumoCC3200/utility/Utilities.h

   1 /*
   2  * Copyright (c) 2014, Texas Instruments Incorporated
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * *  Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * *  Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * *  Neither the name of Texas Instruments Incorporated nor the names of
  17  *    its contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /*  Utilities.h
  34  *
  35  *  A class that includes a variety of useful "number - related"
  36  *  operations.
  37  */
  38
  39 #ifndef Utilities_h
  40 #define Utilities_h
  41
  42 class Utilities {
  43 public:
  44     Utilities();
  45
  46     static float wrapAngle(float angle);
  47     static float wrapAngle360(float angle);
  48     static float saturate(float value, float min, float max);
  49     static bool inRange(float value, float lowerBound, float upperBound);
  50     static int clip(int input);
  51     static float clip(float input);
  52     static int min(int a, int b);
  53     static int max(int a, int b);
  54     static float toDegrees(float angle);
  55
  56     struct MotorInfo {
  57         float error;
  58         float leftSpeed;
  59         float rightSpeed;
  60         float time;
  61     };
  62 private:
  63 };
  64 #endif
  65