pth_hole_size.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/>.
 */
 
#pragma once
 
#include <vector>
 
#include <wx/string.h>
 
 
// Sizes used in this file are in nanometers (nm) unless otherwise specified.
 
enum class PTH_LEAD_SHAPE
{
    ROUND,
    SQUARE,
    RECTANGULAR
};
 
// How a recommended hole size is chosen from the allowable range: rounded to the nearest
// multiple of the rounding step, or rounded up to the next multiple.
enum class PTH_HOLE_ROUNDING
{
    NEAREST,
    UP
};
 
struct PTH_LEAD_DEF
{
    PTH_LEAD_SHAPE m_shape = PTH_LEAD_SHAPE::ROUND; // Lead cross-section shape
    int            m_minX = 0;                      // Smallest X dimension of the lead
    int            m_maxX = 0;                      // Largest X dimension of the lead
    int            m_minY = 0;                      // Smallest Y dimension of the lead (rectangular leads only)
    int            m_maxY = 0;                      // Largest Y dimension of the lead (rectangular leads only)
};
 
// The allowable hole size range a standard computes for a given lead.  The standard defines
// the range; choosing a specific (recommended) hole within it is a design decision and is done
// separately (see ComputeRecommendedPthHoleSize).
struct PTH_HOLE_SIZE_RESULT
{
    int m_leadMin = 0; // Effective smallest lead size
    int m_leadMax = 0; // Effective largest lead size
    int m_holeMin = 0; // Smallest allowable finished hole
    int m_holeMax = 0; // Largest allowable finished hole
};

class PTH_HOLE_SIZE_STANDARD
{
public:
    virtual ~PTH_HOLE_SIZE_STANDARD() = default;

    virtual const wxString& GetID() const = 0;

    virtual const wxString& GetDisplayName() const = 0;

    virtual int GetLevelCount() const = 0;

    virtual wxString GetLevelName( int aLevel ) const = 0;

    virtual int GetMinHoleAddend( int aLevel ) const = 0;

    virtual int GetMaxHoleAddend( int aLevel ) const = 0;

    virtual PTH_HOLE_SIZE_RESULT ComputeHoleSize( int aLevel, const PTH_LEAD_DEF& aLead ) const = 0;
};

int ComputeRecommendedPthHoleSize( const PTH_HOLE_SIZE_RESULT& aRange, int aRoundingStep, PTH_HOLE_ROUNDING aRounding );

const PTH_HOLE_SIZE_STANDARD* FindPthHoleSizeStandard( const wxString& aId );

const std::vector<const PTH_HOLE_SIZE_STANDARD*>& GetPthHoleSizeStandards();