pads_unit_converter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef PADS_UNIT_CONVERTER_H
#define PADS_UNIT_CONVERTER_H
 
#include <cstdint>
#include <optional>
#include <string>
#include <vector>
 
enum class PADS_UNIT_TYPE
{
    MILS,       
    METRIC,     
    INCHES
};

class PADS_UNIT_CONVERTER
{
public:
    PADS_UNIT_CONVERTER();
 
    void SetBaseUnits( PADS_UNIT_TYPE aUnitType );
 
    PADS_UNIT_TYPE GetUnitType() const { return m_unitType; }

    void SetBasicUnitsMode( bool aEnabled );
 
    bool IsBasicUnitsMode() const { return m_basicUnitsMode; }

    void SetBasicUnitsScale( double aScale );
 
    double GetBasicUnitsScale() const { return m_basicUnitsScale; }

    bool ParseFileHeader( const std::string& aHeader );

    static std::optional<PADS_UNIT_TYPE> ParseUnitCode( const std::string& aUnitCode );

    bool PushUnitOverride( const std::string& aUnitCode );

    void PopUnitOverride();
 
    bool HasUnitOverride() const { return !m_unitOverrideStack.empty(); }
 
    size_t GetOverrideDepth() const { return m_unitOverrideStack.size(); }

    int64_t ToNanometers( double aValue ) const;

    int64_t ToNanometersSize( double aValue ) const;
 
    static constexpr double MILS_TO_NM = 25400.0;           // 1 mil = 25.4 um = 25400 nm
    static constexpr double MM_TO_NM = 1000000.0;           // 1 mm = 1,000,000 nm
    static constexpr double INCHES_TO_NM = 25400000.0;      // 1 inch = 25.4 mm = 25,400,000 nm
    static constexpr double BASIC_TO_NM = MILS_TO_NM / 38100.0; // 1 BASIC unit = 1/38100 mil
 
private:
    void updateScaleFactor();
 
    PADS_UNIT_TYPE              m_unitType;
    double                      m_scaleFactor;
    bool                        m_basicUnitsMode;
    double                      m_basicUnitsScale;
    std::vector<PADS_UNIT_TYPE> m_unitOverrideStack;
};
 
#endif // PADS_UNIT_CONVERTER_H