ENUHeading.hpp

Go to the documentation of this file.

/*
 * ----------------- BEGIN LICENSE BLOCK ---------------------------------
 *
 * Copyright (C) 2018-2020 Intel Corporation
 *
 * SPDX-License-Identifier: MIT
 *
 * ----------------- END LICENSE BLOCK -----------------------------------
 */
 
#pragma once
 
#include <cmath>
#include <iostream>
#include <limits>
#include <sstream>
#include <stdexcept>
#include "spdlog/fmt/ostr.h"
#include "spdlog/spdlog.h"
namespace ad {
namespace map {
namespace point {
 
#define AD_MAP_POINT_ENUHEADING_THROWS_EXCEPTION 1
 
#if SAFE_DATATYPES_EXPLICIT_CONVERSION
 
#define _AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_ explicit
#else
 
#define _AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_
#endif
 
class ENUHeading
{
public:
  static const double cMinValue;
 
  static const double cMaxValue;
 
  static const double cPrecisionValue;
 
  ENUHeading()
    : mENUHeading(std::numeric_limits<double>::quiet_NaN())
  {
  }
 
  _AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_ ENUHeading(double const iENUHeading)
    : mENUHeading(iENUHeading)
  {
  }
 
  ENUHeading(const ENUHeading &other) = default;
 
  ENUHeading(ENUHeading &&other) = default;
 
  ENUHeading &operator=(const ENUHeading &other) = default;
 
  ENUHeading &operator=(ENUHeading &&other) = default;
 
  bool operator==(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    return std::fabs(mENUHeading - other.mENUHeading) < cPrecisionValue;
  }
 
  bool operator!=(const ENUHeading &other) const
  {
    return !operator==(other);
  }
 
  bool operator>(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    return (mENUHeading > other.mENUHeading) && operator!=(other);
  }
 
  bool operator<(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    return (mENUHeading < other.mENUHeading) && operator!=(other);
  }
 
  bool operator>=(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    return ((mENUHeading > other.mENUHeading) || operator==(other));
  }
 
  bool operator<=(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    return ((mENUHeading < other.mENUHeading) || operator==(other));
  }
 
  ENUHeading operator+(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    ENUHeading const result(mENUHeading + other.mENUHeading);
    result.ensureValid();
    return result;
  }
 
  ENUHeading &operator+=(const ENUHeading &other)
  {
    ensureValid();
    other.ensureValid();
    mENUHeading += other.mENUHeading;
    ensureValid();
    return *this;
  }
 
  ENUHeading operator-(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValid();
    ENUHeading const result(mENUHeading - other.mENUHeading);
    result.ensureValid();
    return result;
  }
 
  ENUHeading operator-=(const ENUHeading &other)
  {
    ensureValid();
    other.ensureValid();
    mENUHeading -= other.mENUHeading;
    ensureValid();
    return *this;
  }
 
  ENUHeading operator*(const double &scalar) const
  {
    ensureValid();
    ENUHeading const result(mENUHeading * scalar);
    result.ensureValid();
    return result;
  }
 
  ENUHeading operator/(const double &scalar) const
  {
    ENUHeading const scalarENUHeading(scalar);
    ENUHeading const result(operator/(scalarENUHeading));
    result.ensureValid();
    return result;
  }
 
  double operator/(const ENUHeading &other) const
  {
    ensureValid();
    other.ensureValidNonZero();
    double const result = mENUHeading / other.mENUHeading;
    return result;
  }
 
  ENUHeading operator-() const
  {
    ensureValid();
    ENUHeading const result(-mENUHeading);
    result.ensureValid(); // LCOV_EXCL_BR_LINE Some types do not throw an exception
    return result;
  }
 
  _AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_ operator double() const
  {
    return mENUHeading;
  }
 
  bool isValid() const
  {
    auto const valueClass = std::fpclassify(mENUHeading);
    return ((valueClass == FP_NORMAL) || (valueClass == FP_ZERO)) && (cMinValue <= mENUHeading)
      && (mENUHeading <= cMaxValue);
  }
 
  void ensureValid() const
  {
    if (!isValid())
    {
      spdlog::info("ensureValid(::ad::map::point::ENUHeading)>> {} value out of range", *this); // LCOV_EXCL_BR_LINE
#if (AD_MAP_POINT_ENUHEADING_THROWS_EXCEPTION == 1)
      throw std::out_of_range("ENUHeading value out of range"); // LCOV_EXCL_BR_LINE
#endif
    }
  }
 
  void ensureValidNonZero() const
  {
    ensureValid();
    if (operator==(ENUHeading(0.))) // LCOV_EXCL_BR_LINE
    {
      spdlog::info("ensureValid(::ad::map::point::ENUHeading)>> {} value is zero", *this); // LCOV_EXCL_BR_LINE
#if (AD_MAP_POINT_ENUHEADING_THROWS_EXCEPTION == 1)
      throw std::out_of_range("ENUHeading value is zero"); // LCOV_EXCL_BR_LINE
#endif
    }
  }
 
  static ENUHeading getMin()
  {
    return ENUHeading(cMinValue);
  }
 
  static ENUHeading getMax()
  {
    return ENUHeading(cMaxValue);
  }
 
  static ENUHeading getPrecision()
  {
    return ENUHeading(cPrecisionValue);
  }
 
private:
  double mENUHeading;
};
 
} // namespace point
} // namespace map
} // namespace ad
inline ::ad::map::point::ENUHeading operator*(const double &other, ::ad::map::point::ENUHeading const &value)
{
  return value.operator*(other);
}
 
namespace std {
 
inline ::ad::map::point::ENUHeading fabs(const ::ad::map::point::ENUHeading other)
{
  ::ad::map::point::ENUHeading const result(std::fabs(static_cast<double>(other)));
  return result;
}
 
template <> class numeric_limits<::ad::map::point::ENUHeading> : public numeric_limits<double>
{
public:
  static inline ::ad::map::point::ENUHeading lowest()
  {
    return ::ad::map::point::ENUHeading::getMin();
  }
  static inline ::ad::map::point::ENUHeading max()
  {
    return ::ad::map::point::ENUHeading::getMax();
  }
 
  static inline ::ad::map::point::ENUHeading epsilon()
  {
    return ::ad::map::point::ENUHeading::getPrecision();
  }
};
 
} // namespace std
 
#ifndef GEN_GUARD_AD_MAP_POINT_ENUHEADING
#define GEN_GUARD_AD_MAP_POINT_ENUHEADING
 
namespace ad {
namespace map {
namespace point {
 
inline std::ostream &operator<<(std::ostream &os, ENUHeading const &_value)
{
  return os << double(_value);
}
 
} // namespace point
} // namespace map
} // namespace ad
 
namespace std {
inline std::string to_string(::ad::map::point::ENUHeading const &value)
{
  return to_string(static_cast<double>(value));
}
} // namespace std
#endif // GEN_GUARD_AD_MAP_POINT_ENUHEADING