KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PTH_HOLE_SIZE_STANDARD Class Referenceabstract

A source of hole size rules for a plated through hole. More...

#include <pth_hole_size.h>

Public Member Functions

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
 Compute the allowable hole size range for a lead.
 

Detailed Description

A source of hole size rules for a plated through hole.

It's likely the exact interface will change as more standards are added, but this is a start.

Definition at line 70 of file pth_hole_size.h.

Constructor & Destructor Documentation

◆ ~PTH_HOLE_SIZE_STANDARD()

virtual PTH_HOLE_SIZE_STANDARD::~PTH_HOLE_SIZE_STANDARD ( )
virtualdefault

Member Function Documentation

◆ ComputeHoleSize()

virtual PTH_HOLE_SIZE_RESULT PTH_HOLE_SIZE_STANDARD::ComputeHoleSize ( int aLevel,
const PTH_LEAD_DEF & aLead ) const
pure virtual

Compute the allowable hole size range for a lead.

The effective lead size used for hole sizing is the diameter for a round lead and the diagonal for a square or rectangular lead.

Parameters
aLevelis the density level index, in the range [0, GetLevelCount()).
aLeadis the lead cross-section shape and dimensions.
Returns
the effective lead sizes and the allowable finished hole range.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ GetDisplayName()

virtual const wxString & PTH_HOLE_SIZE_STANDARD::GetDisplayName ( ) const
pure virtual
Returns
the display name of the standard, used for menus and titles.

◆ GetID()

virtual const wxString & PTH_HOLE_SIZE_STANDARD::GetID ( ) const
pure virtual
Returns
a unique ID for the standard, e.g. "IPC-2222B".

◆ GetLevelCount()

virtual int PTH_HOLE_SIZE_STANDARD::GetLevelCount ( ) const
pure virtual
Returns
the number of density levels the standard defines (e.g. 3 for the IPC-2222B levels A, B and C).

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetLevelName()

virtual wxString PTH_HOLE_SIZE_STANDARD::GetLevelName ( int aLevel) const
pure virtual
Parameters
aLevelis the level index, in the range [0, GetLevelCount()).
Returns
the display name of the density level.

◆ GetMaxHoleAddend()

virtual int PTH_HOLE_SIZE_STANDARD::GetMaxHoleAddend ( int aLevel) const
pure virtual
Parameters
aLevelis the level index, in the range [0, GetLevelCount()).
Returns
the allowance added to the smallest lead size to give the largest allowable hole for that level.

◆ GetMinHoleAddend()

virtual int PTH_HOLE_SIZE_STANDARD::GetMinHoleAddend ( int aLevel) const
pure virtual
Parameters
aLevelis the level index, in the range [0, GetLevelCount()).
Returns
the allowance added to the largest lead size to give the smallest allowable hole for that level.

The documentation for this class was generated from the following file: