Use consistent terminology.

Fixes https://gitlab.com/kicad/code/kicad/issues/8681
This commit is contained in:
Jeff Young 2021-06-26 10:11:22 +01:00
parent 173c9a974c
commit 81fc710a5d
15 changed files with 39 additions and 39 deletions

View File

@ -683,7 +683,7 @@ public:
// connected track // connected track
int m_MinClearance; // overall min clearance int m_MinClearance; // overall min clearance
int m_TrackMinWidth; // overall min track width int m_TrackMinWidth; // overall min track width
int m_ViasMinAnnulus; // overall minimum width of the via copper ring int m_ViasMinAnnularWidth; // overall minimum width of the via copper ring
int m_ViasMinSize; // overall vias (not micro vias) min diameter int m_ViasMinSize; // overall vias (not micro vias) min diameter
int m_MinThroughDrill; // through hole (not micro vias) min drill diameter int m_MinThroughDrill; // through hole (not micro vias) min drill diameter
int m_MicroViasMinSize; // micro vias min diameter int m_MicroViasMinSize; // micro vias min diameter

View File

@ -228,7 +228,7 @@ set( PCBNEW_MICROWAVE_SRCS
set( PCBNEW_DRC_SRCS set( PCBNEW_DRC_SRCS
drc/drc_results_provider.cpp drc/drc_results_provider.cpp
drc/drc_test_provider.cpp drc/drc_test_provider.cpp
drc/drc_test_provider_annulus.cpp drc/drc_test_provider_annular_width.cpp
drc/drc_test_provider_disallow.cpp drc/drc_test_provider_disallow.cpp
drc/drc_test_provider_connectivity.cpp drc/drc_test_provider_connectivity.cpp
drc/drc_test_provider_copper_clearance.cpp drc/drc_test_provider_copper_clearance.cpp

View File

@ -141,7 +141,7 @@ BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std:
m_MinClearance = Millimeter2iu( DEFAULT_MINCLEARANCE ); m_MinClearance = Millimeter2iu( DEFAULT_MINCLEARANCE );
m_TrackMinWidth = Millimeter2iu( DEFAULT_TRACKMINWIDTH ); m_TrackMinWidth = Millimeter2iu( DEFAULT_TRACKMINWIDTH );
m_ViasMinAnnulus = Millimeter2iu( DEFAULT_VIASMINSIZE - DEFAULT_MINTHROUGHDRILL ) / 2; m_ViasMinAnnularWidth = Millimeter2iu( DEFAULT_VIASMINSIZE - DEFAULT_MINTHROUGHDRILL ) / 2;
m_ViasMinSize = Millimeter2iu( DEFAULT_VIASMINSIZE ); m_ViasMinSize = Millimeter2iu( DEFAULT_VIASMINSIZE );
m_MinThroughDrill = Millimeter2iu( DEFAULT_MINTHROUGHDRILL ); m_MinThroughDrill = Millimeter2iu( DEFAULT_MINTHROUGHDRILL );
m_MicroViasMinSize = Millimeter2iu( DEFAULT_MICROVIASMINSIZE ); m_MicroViasMinSize = Millimeter2iu( DEFAULT_MICROVIASMINSIZE );
@ -216,9 +216,9 @@ BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std:
Millimeter2iu( DEFAULT_TRACKMINWIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), Millimeter2iu( DEFAULT_TRACKMINWIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ),
MM_PER_IU ) ); MM_PER_IU ) );
m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width", &m_ViasMinAnnulus, m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
Millimeter2iu( DEFAULT_VIASMINSIZE ), Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), &m_ViasMinAnnularWidth, Millimeter2iu( DEFAULT_VIASMINSIZE ), Millimeter2iu( 0.01 ),
MM_PER_IU ) ); Millimeter2iu( 25.0 ), MM_PER_IU ) );
m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter", &m_ViasMinSize, m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter", &m_ViasMinSize,
Millimeter2iu( DEFAULT_VIASMINSIZE ), Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), Millimeter2iu( DEFAULT_VIASMINSIZE ), Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ),
@ -678,7 +678,7 @@ void BOARD_DESIGN_SETTINGS::initFromOther( const BOARD_DESIGN_SETTINGS& aOther )
m_UseConnectedTrackWidth = aOther.m_UseConnectedTrackWidth; m_UseConnectedTrackWidth = aOther.m_UseConnectedTrackWidth;
m_MinClearance = aOther.m_MinClearance; m_MinClearance = aOther.m_MinClearance;
m_TrackMinWidth = aOther.m_TrackMinWidth; m_TrackMinWidth = aOther.m_TrackMinWidth;
m_ViasMinAnnulus = aOther.m_ViasMinAnnulus; m_ViasMinAnnularWidth = aOther.m_ViasMinAnnularWidth;
m_ViasMinSize = aOther.m_ViasMinSize; m_ViasMinSize = aOther.m_ViasMinSize;
m_MinThroughDrill = aOther.m_MinThroughDrill; m_MinThroughDrill = aOther.m_MinThroughDrill;
m_MicroViasMinSize = aOther.m_MicroViasMinSize; m_MicroViasMinSize = aOther.m_MicroViasMinSize;

View File

@ -76,7 +76,7 @@ bool PANEL_SETUP_CONSTRAINTS::TransferDataToWindow()
m_minClearance.SetValue( m_BrdSettings->m_MinClearance ); m_minClearance.SetValue( m_BrdSettings->m_MinClearance );
m_trackMinWidth.SetValue( m_BrdSettings->m_TrackMinWidth ); m_trackMinWidth.SetValue( m_BrdSettings->m_TrackMinWidth );
m_viaMinAnnulus.SetValue( m_BrdSettings->m_ViasMinAnnulus ); m_viaMinAnnulus.SetValue( m_BrdSettings->m_ViasMinAnnularWidth );
m_viaMinSize.SetValue(m_BrdSettings->m_ViasMinSize ); m_viaMinSize.SetValue(m_BrdSettings->m_ViasMinSize );
m_holeClearance.SetValue( m_BrdSettings->m_HoleClearance ); m_holeClearance.SetValue( m_BrdSettings->m_HoleClearance );
m_edgeClearance.SetValue( m_BrdSettings->m_CopperEdgeClearance ); m_edgeClearance.SetValue( m_BrdSettings->m_CopperEdgeClearance );
@ -134,7 +134,7 @@ bool PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow()
m_BrdSettings->m_MinClearance = m_minClearance.GetValue(); m_BrdSettings->m_MinClearance = m_minClearance.GetValue();
m_BrdSettings->m_TrackMinWidth = m_trackMinWidth.GetValue(); m_BrdSettings->m_TrackMinWidth = m_trackMinWidth.GetValue();
m_BrdSettings->m_ViasMinAnnulus = m_viaMinAnnulus.GetValue(); m_BrdSettings->m_ViasMinAnnularWidth = m_viaMinAnnulus.GetValue();
m_BrdSettings->m_ViasMinSize = m_viaMinSize.GetValue(); m_BrdSettings->m_ViasMinSize = m_viaMinSize.GetValue();
m_BrdSettings->m_HoleClearance = m_holeClearance.GetValue(); m_BrdSettings->m_HoleClearance = m_holeClearance.GetValue();
m_BrdSettings->SetCopperEdgeClearance( m_edgeClearance.GetValue() ); m_BrdSettings->SetCopperEdgeClearance( m_edgeClearance.GetValue() );

View File

@ -239,7 +239,7 @@ void PANEL_SETUP_RULES::onScintillaCharAdded( wxStyledTextEvent &aEvent )
} }
else if( sexprs.top() == "constraint" ) else if( sexprs.top() == "constraint" )
{ {
tokens = "annulus_width " tokens = "annular_width "
"clearance " "clearance "
"courtyard_clearance " "courtyard_clearance "
"diff_pair_gap " "diff_pair_gap "

View File

@ -156,7 +156,7 @@ void DRC_ENGINE::loadImplicitRules()
rule->AddConstraint( drillConstraint ); rule->AddConstraint( drillConstraint );
DRC_CONSTRAINT annulusConstraint( ANNULAR_WIDTH_CONSTRAINT ); DRC_CONSTRAINT annulusConstraint( ANNULAR_WIDTH_CONSTRAINT );
annulusConstraint.Value().SetMin( bds.m_ViasMinAnnulus ); annulusConstraint.Value().SetMin( bds.m_ViasMinAnnularWidth );
rule->AddConstraint( annulusConstraint ); rule->AddConstraint( annulusConstraint );
DRC_CONSTRAINT diameterConstraint( VIA_DIAMETER_CONSTRAINT ); DRC_CONSTRAINT diameterConstraint( VIA_DIAMETER_CONSTRAINT );

View File

@ -48,7 +48,7 @@ enum PCB_DRC_CODE {
DRCE_DRILLED_HOLES_COLOCATED, // two holes at the same location DRCE_DRILLED_HOLES_COLOCATED, // two holes at the same location
DRCE_HOLE_CLEARANCE, // DRCE_HOLE_CLEARANCE, //
DRCE_TRACK_WIDTH, // Track width is too small or too large DRCE_TRACK_WIDTH, // Track width is too small or too large
DRCE_ANNULAR_WIDTH, // Via size and drill leave annulus too small or too large DRCE_ANNULAR_WIDTH, // Via size and drill leave annular ring too small
DRCE_DRILL_OUT_OF_RANGE, // Too small via or pad drill DRCE_DRILL_OUT_OF_RANGE, // Too small via or pad drill
DRCE_VIA_DIAMETER, // Via diameter checks (min/max) DRCE_VIA_DIAMETER, // Via diameter checks (min/max)
DRCE_PADSTACK, // something is wrong with a pad or via stackup DRCE_PADSTACK, // something is wrong with a pad or via stackup

View File

@ -32,21 +32,21 @@
Via/pad annular ring width test. Checks if there's sufficient copper ring around Via/pad annular ring width test. Checks if there's sufficient copper ring around
PTH/NPTH holes (vias/pads) PTH/NPTH holes (vias/pads)
Errors generated: Errors generated:
- DRCE_ANNULUS - DRCE_ANNULAR_WIDTH
Todo: Todo:
- check pad holes too. - check pad holes too.
- pad stack support (different IAR/OAR values depending on layer) - pad stack support (different IAR/OAR values depending on layer)
*/ */
class DRC_TEST_PROVIDER_ANNULUS : public DRC_TEST_PROVIDER class DRC_TEST_PROVIDER_ANNULAR_WIDTH : public DRC_TEST_PROVIDER
{ {
public: public:
DRC_TEST_PROVIDER_ANNULUS() DRC_TEST_PROVIDER_ANNULAR_WIDTH()
{ {
} }
virtual ~DRC_TEST_PROVIDER_ANNULUS() virtual ~DRC_TEST_PROVIDER_ANNULAR_WIDTH()
{ {
} }
@ -54,7 +54,7 @@ public:
virtual const wxString GetName() const override virtual const wxString GetName() const override
{ {
return "annulus"; return "annular_width";
}; };
virtual const wxString GetDescription() const override virtual const wxString GetDescription() const override
@ -68,7 +68,7 @@ public:
}; };
bool DRC_TEST_PROVIDER_ANNULUS::Run() bool DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run()
{ {
if( m_drcEngine->IsErrorLimitExceeded( DRCE_ANNULAR_WIDTH ) ) if( m_drcEngine->IsErrorLimitExceeded( DRCE_ANNULAR_WIDTH ) )
{ {
@ -80,14 +80,14 @@ bool DRC_TEST_PROVIDER_ANNULUS::Run()
if( !m_drcEngine->HasRulesForConstraintType( ANNULAR_WIDTH_CONSTRAINT ) ) if( !m_drcEngine->HasRulesForConstraintType( ANNULAR_WIDTH_CONSTRAINT ) )
{ {
reportAux( "No annulus constraints found. Tests not run." ); reportAux( "No annular width constraints found. Tests not run." );
return true; // continue with other tests return true; // continue with other tests
} }
if( !reportPhase( _( "Checking via annular rings..." ) ) ) if( !reportPhase( _( "Checking via annular rings..." ) ) )
return false; // DRC cancelled return false; // DRC cancelled
auto checkAnnulus = auto checkAnnularWidth =
[&]( BOARD_ITEM* item ) -> bool [&]( BOARD_ITEM* item ) -> bool
{ {
if( m_drcEngine->IsErrorLimitExceeded( DRCE_ANNULAR_WIDTH ) ) if( m_drcEngine->IsErrorLimitExceeded( DRCE_ANNULAR_WIDTH ) )
@ -104,20 +104,20 @@ bool DRC_TEST_PROVIDER_ANNULUS::Run()
// PADSTACKS TODO: once we have padstacks we'll need to run this per-layer.... // PADSTACKS TODO: once we have padstacks we'll need to run this per-layer....
auto constraint = m_drcEngine->EvalRules( ANNULAR_WIDTH_CONSTRAINT, via, nullptr, auto constraint = m_drcEngine->EvalRules( ANNULAR_WIDTH_CONSTRAINT, via, nullptr,
UNDEFINED_LAYER ); UNDEFINED_LAYER );
int annulus = ( via->GetWidth() - via->GetDrillValue() ) / 2; int annularWidth = ( via->GetWidth() - via->GetDrillValue() ) / 2;
bool fail_min = false; bool fail_min = false;
bool fail_max = false; bool fail_max = false;
if( constraint.Value().HasMin() ) if( constraint.Value().HasMin() )
{ {
v_min = constraint.Value().Min(); v_min = constraint.Value().Min();
fail_min = annulus < v_min; fail_min = annularWidth < v_min;
} }
if( constraint.Value().HasMax() ) if( constraint.Value().HasMax() )
{ {
v_max = constraint.Value().Max(); v_max = constraint.Value().Max();
fail_max = annulus > v_max; fail_max = annularWidth > v_max;
} }
if( fail_min || fail_max ) if( fail_min || fail_max )
@ -128,13 +128,13 @@ bool DRC_TEST_PROVIDER_ANNULUS::Run()
m_msg.Printf( _( "(%s min annular width %s; actual %s)" ), m_msg.Printf( _( "(%s min annular width %s; actual %s)" ),
constraint.GetName(), constraint.GetName(),
MessageTextFromValue( userUnits(), v_min ), MessageTextFromValue( userUnits(), v_min ),
MessageTextFromValue( userUnits(), annulus ) ); MessageTextFromValue( userUnits(), annularWidth ) );
if( fail_max ) if( fail_max )
m_msg.Printf( _( "(%s max annular width %s; actual %s)" ), m_msg.Printf( _( "(%s max annular width %s; actual %s)" ),
constraint.GetName(), constraint.GetName(),
MessageTextFromValue( userUnits(), v_max ), MessageTextFromValue( userUnits(), v_max ),
MessageTextFromValue( userUnits(), annulus ) ); MessageTextFromValue( userUnits(), annularWidth ) );
drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + m_msg ); drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + m_msg );
drcItem->SetItems( item ); drcItem->SetItems( item );
@ -154,7 +154,7 @@ bool DRC_TEST_PROVIDER_ANNULUS::Run()
if( !reportProgress( ii++, board->Tracks().size(), delta ) ) if( !reportProgress( ii++, board->Tracks().size(), delta ) )
break; break;
if( !checkAnnulus( item ) ) if( !checkAnnularWidth( item ) )
return false; // DRC cancelled return false; // DRC cancelled
} }
@ -164,13 +164,13 @@ bool DRC_TEST_PROVIDER_ANNULUS::Run()
} }
int DRC_TEST_PROVIDER_ANNULUS::GetNumPhases() const int DRC_TEST_PROVIDER_ANNULAR_WIDTH::GetNumPhases() const
{ {
return 1; return 1;
} }
std::set<DRC_CONSTRAINT_T> DRC_TEST_PROVIDER_ANNULUS::GetConstraintTypes() const std::set<DRC_CONSTRAINT_T> DRC_TEST_PROVIDER_ANNULAR_WIDTH::GetConstraintTypes() const
{ {
return { ANNULAR_WIDTH_CONSTRAINT }; return { ANNULAR_WIDTH_CONSTRAINT };
} }
@ -178,5 +178,5 @@ std::set<DRC_CONSTRAINT_T> DRC_TEST_PROVIDER_ANNULUS::GetConstraintTypes() const
namespace detail namespace detail
{ {
static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_ANNULUS> dummy; static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_ANNULAR_WIDTH> dummy;
} }

View File

@ -626,7 +626,7 @@ void CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules()
ds.m_TrackMinWidth = getKiCadLength( Assignments.Technology.MinRouteWidth ); ds.m_TrackMinWidth = getKiCadLength( Assignments.Technology.MinRouteWidth );
ds.m_ViasMinSize = ds.m_TrackMinWidth; // Not specified, assumed same as track width ds.m_ViasMinSize = ds.m_TrackMinWidth; // Not specified, assumed same as track width
ds.m_ViasMinAnnulus = ds.m_TrackMinWidth / 2; // Not specified, assumed half track width ds.m_ViasMinAnnularWidth = ds.m_TrackMinWidth / 2; // Not specified, assumed half track width
ds.m_MinThroughDrill = PCB_IU_PER_MM * 0.0508; // CADSTAR does not specify a minimum hole size ds.m_MinThroughDrill = PCB_IU_PER_MM * 0.0508; // CADSTAR does not specify a minimum hole size
// so set to minimum permitted in KiCad (2 mils) // so set to minimum permitted in KiCad (2 mils)
ds.m_HoleClearance = ds.m_CopperEdgeClearance; // Not specified, assumed same as edge ds.m_HoleClearance = ds.m_CopperEdgeClearance; // Not specified, assumed same as edge

View File

@ -401,8 +401,8 @@ BOARD* EAGLE_PLUGIN::Load( const wxString& aFileName, BOARD* aAppendToMe,
if( m_min_hole < designSettings.m_MinThroughDrill ) if( m_min_hole < designSettings.m_MinThroughDrill )
designSettings.m_MinThroughDrill = m_min_hole; designSettings.m_MinThroughDrill = m_min_hole;
if( m_min_annulus < designSettings.m_ViasMinAnnulus ) if( m_min_annulus < designSettings.m_ViasMinAnnularWidth )
designSettings.m_ViasMinAnnulus = m_min_annulus; designSettings.m_ViasMinAnnularWidth = m_min_annulus;
if( m_rules->mdWireWire ) if( m_rules->mdWireWire )
{ {

View File

@ -1732,7 +1732,7 @@ void PCB_PARSER::parseSetup()
break; break;
case T_via_min_annulus: case T_via_min_annulus:
designSettings.m_ViasMinAnnulus = parseBoardUnits( T_via_min_annulus ); designSettings.m_ViasMinAnnularWidth = parseBoardUnits( T_via_min_annulus );
m_board->m_LegacyDesignSettingsLoaded = true; m_board->m_LegacyDesignSettingsLoaded = true;
NeedRIGHT(); NeedRIGHT();
break; break;

View File

@ -691,8 +691,8 @@ void PAD_TOOL::recombinePad( PAD* aPad )
ERROR_INSIDE ); ERROR_INSIDE );
aPad->SetAnchorPadShape( PAD_SHAPE::CIRCLE ); aPad->SetAnchorPadShape( PAD_SHAPE::CIRCLE );
wxSize minAnnulus( Millimeter2iu( 0.2 ), Millimeter2iu( 0.2 ) ); wxSize minAnnularRingWidth( Millimeter2iu( 0.2 ), Millimeter2iu( 0.2 ) );
aPad->SetSize( aPad->GetDrillSize() + minAnnulus ); aPad->SetSize( aPad->GetDrillSize() + minAnnularRingWidth );
aPad->SetOffset( wxPoint( 0, 0 ) ); aPad->SetOffset( wxPoint( 0, 0 ) );
PCB_SHAPE* shape = new PCB_SHAPE; PCB_SHAPE* shape = new PCB_SHAPE;

View File

@ -1570,9 +1570,9 @@ bool ZONE_FILLER::addHatchFillTypeOnZone( const ZONE* aZone, PCB_LAYER_ID aLayer
// enough. // enough.
int pad_width = std::min( pad->GetSize().x, pad->GetSize().y ); int pad_width = std::min( pad->GetSize().x, pad->GetSize().y );
int slot_width = std::min( pad->GetDrillSize().x, pad->GetDrillSize().y ); int slot_width = std::min( pad->GetDrillSize().x, pad->GetDrillSize().y );
int min_annulus = ( pad_width - slot_width ) / 2; int min_annular_ring_width = ( pad_width - slot_width ) / 2;
int clearance = std::max( min_apron_radius - pad_width / 2, int clearance = std::max( min_apron_radius - pad_width / 2,
outline_margin - min_annulus ); outline_margin - min_annular_ring_width );
clearance = std::max( 0, clearance - linethickness / 2 ); clearance = std::max( 0, clearance - linethickness / 2 );
pad->TransformShapeWithClearanceToPolygon( aprons, aLayer, clearance, pad->TransformShapeWithClearanceToPolygon( aprons, aLayer, clearance,

View File

@ -40,7 +40,7 @@ add_executable( drc_proto
../../pcbnew/drc/drc_test_provider_hole_size.cpp ../../pcbnew/drc/drc_test_provider_hole_size.cpp
../../pcbnew/drc/drc_test_provider_disallow.cpp ../../pcbnew/drc/drc_test_provider_disallow.cpp
../../pcbnew/drc/drc_test_provider_track_width.cpp ../../pcbnew/drc/drc_test_provider_track_width.cpp
../../pcbnew/drc/drc_test_provider_annulus.cpp ../../pcbnew/drc/drc_test_provider_annular_width.cpp
../../pcbnew/drc/drc_test_provider_connectivity.cpp ../../pcbnew/drc/drc_test_provider_connectivity.cpp
../../pcbnew/drc/drc_test_provider_courtyard_clearance.cpp ../../pcbnew/drc/drc_test_provider_courtyard_clearance.cpp
../../pcbnew/drc/drc_test_provider_via_diameter.cpp ../../pcbnew/drc/drc_test_provider_via_diameter.cpp

View File

@ -39,7 +39,7 @@ add_executable( test_pns
../../pcbnew/drc/drc_test_provider_hole_size.cpp ../../pcbnew/drc/drc_test_provider_hole_size.cpp
../../pcbnew/drc/drc_test_provider_disallow.cpp ../../pcbnew/drc/drc_test_provider_disallow.cpp
../../pcbnew/drc/drc_test_provider_track_width.cpp ../../pcbnew/drc/drc_test_provider_track_width.cpp
../../pcbnew/drc/drc_test_provider_annulus.cpp ../../pcbnew/drc/drc_test_provider_annular_width.cpp
../../pcbnew/drc/drc_test_provider_connectivity.cpp ../../pcbnew/drc/drc_test_provider_connectivity.cpp
../../pcbnew/drc/drc_test_provider_courtyard_clearance.cpp ../../pcbnew/drc/drc_test_provider_courtyard_clearance.cpp
../../pcbnew/drc/drc_test_provider_via_diameter.cpp ../../pcbnew/drc/drc_test_provider_via_diameter.cpp