lengthunit.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_LENGTHUNIT_H
#define LIBREPCB_CORE_LENGTHUNIT_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>
 
#include <optional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class Length;
class Point;
 
/*******************************************************************************
 *  Class LengthUnit
 ******************************************************************************/
 
class LengthUnit final {
  Q_DECLARE_TR_FUNCTIONS(LengthUnit)
 
private:
  // Private Types
 
  enum class LengthUnit_t {
    Millimeters = 0,
    Micrometers,
    Nanometers,
    Inches,
    Mils,
    _COUNT  
  };
 
public:
  // Constructors / Destructor
 
  LengthUnit() noexcept : mUnit(LengthUnit_t::Millimeters) {}
 
  LengthUnit(const LengthUnit& other) noexcept : mUnit(other.mUnit) {}
 
  ~LengthUnit() noexcept {}
 
  // Getters
 
  int getIndex() const noexcept { return static_cast<int>(mUnit); }
 
  QString toStr() const noexcept;
 
  QString toStringTr() const noexcept;
 
  QString toShortStringTr() const noexcept;
 
  QString format(const Length& value, const QLocale& locale,
                 const QString& separator = " ") const noexcept;
 
  int getReasonableNumberOfDecimals() const noexcept;
 
  QStringList getUserInputSuffixes() const noexcept;
 
  // General Methods
 
  qreal convertToUnit(const Length& length) const noexcept;
 
  QPointF convertToUnit(const Point& point) const noexcept;
 
  Length convertFromUnit(qreal length) const;
 
  Point convertFromUnit(const QPointF& point) const;
 
  // Static Methods
 
  static LengthUnit fromString(const QString& str);
 
  static LengthUnit fromIndex(int index);
 
  static QList<LengthUnit> getAllUnits() noexcept;
 
  // Static Methods to get all available length units
  static LengthUnit millimeters() noexcept {
    return LengthUnit(LengthUnit_t::Millimeters);
  }
  static LengthUnit micrometers() noexcept {
    return LengthUnit(LengthUnit_t::Micrometers);
  }
  static LengthUnit nanometers() noexcept {
    return LengthUnit(LengthUnit_t::Nanometers);
  }
  static LengthUnit inches() noexcept {
    return LengthUnit(LengthUnit_t::Inches);
  }
  static LengthUnit mils() noexcept { return LengthUnit(LengthUnit_t::Mils); }
 
  static std::optional<LengthUnit> extractFromExpression(
      QString& expression) noexcept;
 
  // Operators
  LengthUnit& operator=(const LengthUnit& rhs) noexcept {
    mUnit = rhs.mUnit;
    return *this;
  }
  bool operator==(const LengthUnit& rhs) const noexcept {
    return mUnit == rhs.mUnit;
  }
  bool operator!=(const LengthUnit& rhs) const noexcept {
    return mUnit != rhs.mUnit;
  }
 
private:
  // Private Methods
 
  explicit LengthUnit(LengthUnit_t unit) noexcept : mUnit(unit) {}
 
  // Attributes
 
  LengthUnit_t mUnit;
};
 
/*******************************************************************************
 *  Non-Member Functions
 ******************************************************************************/
 
inline QDataStream& operator<<(QDataStream& stream, const LengthUnit& unit) {
  stream << unit.toStr();
  return stream;
}
 
inline QDebug operator<<(QDebug stream, const LengthUnit& unit) {
  stream << QString("LengthUnit(%1)").arg(unit.toStr());
  return stream;
}
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif