DRC_TEST_PROVIDER_SLIVER_CHECKER Class Reference

Inheritance diagram for DRC_TEST_PROVIDER_SLIVER_CHECKER:

Public Member Functions
	DRC_TEST_PROVIDER_SLIVER_CHECKER ()
virtual	~DRC_TEST_PROVIDER_SLIVER_CHECKER ()
virtual bool	Run () override
	Run this provider against the given PCB with configured options (if any). More...
virtual const wxString	GetName () const override
virtual const wxString	GetDescription () const override
void	SetDRCEngine (DRC_ENGINE *engine)
bool	RunTests (EDA_UNITS aUnits)
EDA_UNITS	GetUserUnits () const
void	SetUserUnits (EDA_UNITS aUnits)
const EDA_IU_SCALE &	GetIuScale () const
virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()
wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aValue in internal units into a united string. More...
wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)
wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	A lower-precision version of StringFromValue(). More...
wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)
int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aTextValue in aUnits to internal units used by the frame. More...
EDA_ANGLE	AngleValueFromString (const wxString &aTextValue)

Static Public Member Functions
static void	Init ()

Protected Member Functions
int	forEachGeometryItem (const std::vector< KICAD_T > &aTypes, LSET aLayers, const std::function< bool(BOARD_ITEM *)> &aFunc)
virtual void	reportAux (wxString fmt,...)
virtual void	reportViolation (std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, int aMarkerLayer)
virtual bool	reportProgress (int aCount, int aSize, int aDelta)
virtual bool	reportPhase (const wxString &aStageName)
virtual void	reportRuleStatistics ()
virtual void	accountCheck (const DRC_RULE *ruleToTest)
virtual void	accountCheck (const DRC_CONSTRAINT &constraintToTest)
bool	isInvisibleText (const BOARD_ITEM *aItem) const
wxString	formatMsg (const wxString &aFormatString, const wxString &aSource, int aConstraint, int aActual)
EDA_UNITS	userUnits () const

Protected Attributes
DRC_ENGINE *	m_drcEngine
std::unordered_map< const DRC_RULE *, int >	m_stats
bool	m_isRuleDriven = true

Static Protected Attributes
static std::vector< KICAD_T >	s_allBasicItems
static std::vector< KICAD_T >	s_allBasicItemsButZones

Private Member Functions
wxString	layerDesc (PCB_LAYER_ID aLayer)

Private Attributes
const EDA_IU_SCALE &	m_iuScale
EDA_UNITS	m_userUnits

Detailed Description

Definition at line 45 of file drc_test_provider_sliver_checker.cpp.

Constructor & Destructor Documentation

DRC_TEST_PROVIDER_SLIVER_CHECKER()

DRC_TEST_PROVIDER_SLIVER_CHECKER::DRC_TEST_PROVIDER_SLIVER_CHECKER ( )

inline

Definition at line 48 of file drc_test_provider_sliver_checker.cpp.

 {
 }

~DRC_TEST_PROVIDER_SLIVER_CHECKER()

virtual DRC_TEST_PROVIDER_SLIVER_CHECKER::~DRC_TEST_PROVIDER_SLIVER_CHECKER ( )

inlinevirtual

Definition at line 52 of file drc_test_provider_sliver_checker.cpp.

 {
 }

Member Function Documentation

accountCheck() [1/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_CONSTRAINT &  constraintToTest )

protectedvirtualinherited

Definition at line 127 of file drc_test_provider.cpp.

{
 accountCheck( constraintToTest.GetParentRule() );
}

References DRC_TEST_PROVIDER::accountCheck(), and DRC_CONSTRAINT::GetParentRule().

accountCheck() [2/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_RULE *  ruleToTest )

protectedvirtualinherited

Definition at line 116 of file drc_test_provider.cpp.

{
 auto it = m_stats.find( ruleToTest );
 
 if( it == m_stats.end() )
 m_stats[ ruleToTest ] = 1;
 else
 m_stats[ ruleToTest ] += 1;
}

References DRC_TEST_PROVIDER::m_stats.

Referenced by DRC_TEST_PROVIDER::accountCheck(), and DRC_TEST_PROVIDER::reportViolation().

AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString &  aTextValue )

inlineinherited

Definition at line 116 of file units_provider.h.

 {
 double angle = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), EDA_UNITS::DEGREES,
 aTextValue );
 
 return EDA_ANGLE( angle, DEGREES_T );
 }

References PNS::angle(), DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by FP_TEXT_GRID_TABLE::SetValue().

forEachGeometryItem()

int DRC_TEST_PROVIDER::forEachGeometryItem ( const std::vector< KICAD_T > &  aTypes, LSET  aLayers, const std::function< bool(BOARD_ITEM *)> &  aFunc  )

protectedinherited

Definition at line 152 of file drc_test_provider.cpp.

{
 BOARD *brd = m_drcEngine->GetBoard();
 std::bitset<MAX_STRUCT_TYPE_ID> typeMask;
 int n = 0;
 
 if( aTypes.size() == 0 )
 {
 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
 typeMask[ i ] = true;
 }
 else
 {
 for( KICAD_T aType : aTypes )
 typeMask[ aType ] = true;
 }
 
 for( PCB_TRACK* item : brd->Tracks() )
 {
 if( (item->GetLayerSet() & aLayers).any() )
 {
 if( typeMask[ PCB_TRACE_T ] && item->Type() == PCB_TRACE_T )
 {
 aFunc( item );
 n++;
 }
 else if( typeMask[ PCB_VIA_T ] && item->Type() == PCB_VIA_T )
 {
 aFunc( item );
 n++;
 }
 else if( typeMask[ PCB_ARC_T ] && item->Type() == PCB_ARC_T )
 {
 aFunc( item );
 n++;
 }
 }
 }
 
 for( BOARD_ITEM* item : brd->Drawings() )
 {
 if( (item->GetLayerSet() & aLayers).any() )
 {
 if( typeMask[ PCB_DIMENSION_T ] && BaseType( item->Type() ) == PCB_DIMENSION_T )
 {
 if( !aFunc( item ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_SHAPE_T ] && item->Type() == PCB_SHAPE_T )
 {
 if( !aFunc( item ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_TEXT_T ] && item->Type() == PCB_TEXT_T )
 {
 if( !aFunc( item ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_TEXTBOX_T ] && item->Type() == PCB_TEXTBOX_T )
 {
 if( !aFunc( item ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_TARGET_T ] && item->Type() == PCB_TARGET_T )
 {
 if( !aFunc( item ) )
 return n;
 
 n++;
 }
 }
 }
 
 if( typeMask[ PCB_ZONE_T ] )
 {
 for( ZONE* item : brd->Zones() )
 {
 if( ( item->GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( item ) )
 return n;
 
 n++;
 }
 }
 }
 
 for( FOOTPRINT* footprint : brd->Footprints() )
 {
 if( typeMask[ PCB_FP_TEXT_T ] )
 {
 if( ( footprint->Reference().GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( &footprint->Reference() ) )
 return n;
 
 n++;
 }
 
 if( ( footprint->Value().GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( &footprint->Value() ) )
 return n;
 
 n++;
 }
 }
 
 if( typeMask[ PCB_PAD_T ] )
 {
 for( PAD* pad : footprint->Pads() )
 {
 // Careful: if a pad has a hole then it pierces all layers
 if( pad->HasHole() || ( pad->GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( pad ) )
 return n;
 
 n++;
 }
 }
 }
 
 for( BOARD_ITEM* dwg : footprint->GraphicalItems() )
 {
 if( (dwg->GetLayerSet() & aLayers).any() )
 {
 if( typeMask[ PCB_DIMENSION_T ] && BaseType( dwg->Type() ) == PCB_DIMENSION_T )
 {
 if( !aFunc( dwg ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_FP_TEXT_T ] && dwg->Type() == PCB_FP_TEXT_T )
 {
 if( !aFunc( dwg ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_FP_TEXTBOX_T ] && dwg->Type() == PCB_FP_TEXTBOX_T )
 {
 if( !aFunc( dwg ) )
 return n;
 
 n++;
 }
 else if( typeMask[ PCB_FP_SHAPE_T ] && dwg->Type() == PCB_FP_SHAPE_T )
 {
 if( !aFunc( dwg ) )
 return n;
 
 n++;
 }
 }
 }
 
 if( typeMask[ PCB_FP_ZONE_T ] )
 {
 for( ZONE* zone : footprint->Zones() )
 {
 if( (zone->GetLayerSet() & aLayers).any() )
 {
 if( !aFunc( zone ) )
 return n;
 
 n++;
 }
 }
 }
 
 if( typeMask[ PCB_FOOTPRINT_T ] )
 {
 if( !aFunc( footprint ) )
 return n;
 
 n++;
 }
 }
 
 return n;
}

References BaseType(), BOARD::Drawings(), BOARD::Footprints(), DRC_ENGINE::GetBoard(), DRC_TEST_PROVIDER::m_drcEngine, MAX_STRUCT_TYPE_ID, pad, PCB_ARC_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, BOARD::Tracks(), and BOARD::Zones().

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_CACHE_GENERATOR::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), and DRC_TEST_PROVIDER_MISC::testTextVars().

formatMsg()

wxString DRC_TEST_PROVIDER::formatMsg ( const wxString &  aFormatString, const wxString &  aSource, int  aConstraint, int  aActual  )

protectedinherited

Definition at line 365 of file drc_test_provider.cpp.

{
 wxString constraint_str = MessageTextFromValue( aConstraint );
 wxString actual_str = MessageTextFromValue( aActual );
 
 if( constraint_str == actual_str )
 {
 // Use more precise formatting if the message-text strings were equal.
 constraint_str = StringFromValue( aConstraint, true );
 actual_str = StringFromValue( aActual, true );
 }
 
 return wxString::Format( aFormatString, aSource, constraint_str, actual_str );
}

References Format(), UNITS_PROVIDER::MessageTextFromValue(), and UNITS_PROVIDER::StringFromValue().

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

GetDescription()

virtual const wxString DRC_TEST_PROVIDER_SLIVER_CHECKER::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 63 of file drc_test_provider_sliver_checker.cpp.

 {
 return wxT( "Checks copper layers for slivers" );
 }

GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

{ return m_iuScale; }

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

GetName()

virtual const wxString DRC_TEST_PROVIDER_SLIVER_CHECKER::GetName ( void  ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 58 of file drc_test_provider_sliver_checker.cpp.

 {
 return wxT( "sliver checker" );
 };

GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & UNITS_PROVIDER::GetOriginTransforms ( )

inlinevirtualinherited

Reimplemented in EDA_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 48 of file units_provider.h.

 {
 static ORIGIN_TRANSFORMS identityTransform;
 
 return identityTransform;
 }

GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 42 of file units_provider.h.

{ return m_userUnits; }

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PG_UNIT_EDITOR::CreateControls(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDIT_FRAME::GenFootprintsReport(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

Init()

void DRC_TEST_PROVIDER::Init ( )

staticinherited

Definition at line 53 of file drc_test_provider.cpp.

{
 if( s_allBasicItems.size() == 0 )
 {
 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
 {
 if( i != PCB_FOOTPRINT_T && i != PCB_GROUP_T )
 {
 s_allBasicItems.push_back( (KICAD_T) i );
 
 if( i != PCB_ZONE_T && i != PCB_FP_ZONE_T )
 s_allBasicItemsButZones.push_back( (KICAD_T) i );
 }
 }
 }
}

References MAX_STRUCT_TYPE_ID, PCB_FOOTPRINT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_ZONE_T, DRC_TEST_PROVIDER::s_allBasicItems, and DRC_TEST_PROVIDER::s_allBasicItemsButZones.

Referenced by DRC_ENGINE::RunTests().

isInvisibleText()

bool DRC_TEST_PROVIDER::isInvisibleText ( const BOARD_ITEM *  aItem ) const

protectedinherited

Definition at line 346 of file drc_test_provider.cpp.

{
 
 if( const FP_TEXT* text = dyn_cast<const FP_TEXT*>( aItem ) )
 {
 if( !text->IsVisible() )
 return true;
 }
 
 if( const PCB_TEXT* text = dyn_cast<const PCB_TEXT*>( aItem ) )
 {
 if( !text->IsVisible() )
 return true;
 }
 
 return false;
}

References text.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance().

layerDesc()

wxString DRC_TEST_PROVIDER_SLIVER_CHECKER::layerDesc ( PCB_LAYER_ID  aLayer )

private

Definition at line 73 of file drc_test_provider_sliver_checker.cpp.

{
 return wxString::Format( wxT( "(%s)" ), m_drcEngine->GetBoard()->GetLayerName( aLayer ) );
}

References Format(), DRC_ENGINE::GetBoard(), BOARD::GetLayerName(), and DRC_TEST_PROVIDER::m_drcEngine.

Referenced by Run().

MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( const EDA_ANGLE &  aValue, bool  aAddUnitLabel = true  )

inlineinherited

Definition at line 94 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( double  aValue, bool  aAddUnitLabel = true, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  )

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 87 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by CheckLibSymbol(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), DIALOG_NET_INSPECTOR::formatLength(), DRC_TEST_PROVIDER::formatMsg(), LIB_SHAPE::GetItemDescription(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_BITMAP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), TEXT_SEARCH_HANDLER::GetResultCell(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

reportAux()

void DRC_TEST_PROVIDER::reportAux ( wxString  fmt,   ...  )

protectedvirtualinherited

Definition at line 105 of file drc_test_provider.cpp.

{
 va_list vargs;
 va_start( vargs, fmt );
 wxString str;
 str.PrintfV( fmt, vargs );
 va_end( vargs );
 m_drcEngine->ReportAux( str );
}

References DRC_TEST_PROVIDER::m_drcEngine, and DRC_ENGINE::ReportAux().

Referenced by DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

reportPhase()

bool DRC_TEST_PROVIDER::reportPhase ( const wxString &  aStageName )

protectedvirtualinherited

Definition at line 98 of file drc_test_provider.cpp.

{
 reportAux( aMessage );
 return m_drcEngine->ReportPhase( aMessage );
}

References DRC_TEST_PROVIDER::m_drcEngine, DRC_TEST_PROVIDER::reportAux(), and DRC_ENGINE::ReportPhase().

Referenced by DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), and DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions().

reportProgress()

bool DRC_TEST_PROVIDER::reportProgress ( int  aCount, int  aSize, int  aDelta  )

protectedvirtualinherited

Definition at line 86 of file drc_test_provider.cpp.

{
 if( ( aCount % aDelta ) == 0 || aCount == aSize - 1 )
 {
 if( !m_drcEngine->ReportProgress( (double) aCount / (double) aSize ) )
 return false;
 }
 
 return true;
}

References DRC_TEST_PROVIDER::m_drcEngine, and DRC_ENGINE::ReportProgress().

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

reportRuleStatistics()

void DRC_TEST_PROVIDER::reportRuleStatistics ( )

protectedvirtualinherited

Definition at line 133 of file drc_test_provider.cpp.

{
 if( !m_isRuleDriven )
 return;
 
 m_drcEngine->ReportAux( wxT( "Rule hit statistics: " ) );
 
 for( const std::pair<const DRC_RULE* const, int>& stat : m_stats )
 {
 if( stat.first )
 {
 m_drcEngine->ReportAux( wxString::Format( wxT( " - rule '%s': %d hits " ),
 stat.first->m_Name,
 stat.second ) );
 }
 }
}

References Format(), DRC_TEST_PROVIDER::m_drcEngine, DRC_TEST_PROVIDER::m_isRuleDriven, DRC_TEST_PROVIDER::m_stats, and DRC_ENGINE::ReportAux().

Referenced by DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), and DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal().

reportViolation()

void DRC_TEST_PROVIDER::reportViolation ( std::shared_ptr< DRC_ITEM > &  item, const VECTOR2I &  aMarkerPos, int  aMarkerLayer  )

protectedvirtualinherited

Definition at line 75 of file drc_test_provider.cpp.

{
 if( item->GetViolatingRule() )
 accountCheck( item->GetViolatingRule() );
 
 item->SetViolatingTest( this );
 m_drcEngine->ReportViolation( item, aMarkerPos, aMarkerLayer );
}

References DRC_TEST_PROVIDER::accountCheck(), DRC_TEST_PROVIDER::m_drcEngine, and DRC_ENGINE::ReportViolation().

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_MISC::testOutline(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

Run()

bool DRC_TEST_PROVIDER_SLIVER_CHECKER::Run ( )

overridevirtual

Run this provider against the given PCB with configured options (if any).

Implements DRC_TEST_PROVIDER.

Definition at line 79 of file drc_test_provider_sliver_checker.cpp.

{
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_COPPER_SLIVER ) )
 return true; // Continue with other tests
 
 if( !reportPhase( _( "Running sliver detection on copper layers..." ) ) )
 return false; // DRC cancelled
 
 int widthTolerance = pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_SliverWidthTolerance );
 double angleTolerance = ADVANCED_CFG::GetCfg().m_SliverAngleTolerance;
 int testLength = widthTolerance / ( 2 * sin( DEG2RAD( angleTolerance / 2 ) ) );
 LSET copperLayerSet = m_drcEngine->GetBoard()->GetEnabledLayers() & LSET::AllCuMask();
 LSEQ copperLayers = copperLayerSet.Seq();
 int layerCount = copperLayers.size();
 
 // Report progress on board zones only. Everything else is in the noise.
 int zoneLayerCount = 0;
 std::atomic<size_t> done( 1 );
 
 for( PCB_LAYER_ID layer : copperLayers )
 {
 for( ZONE* zone : m_drcEngine->GetBoard()->Zones() )
 {
 if( !zone->GetIsRuleArea() && zone->IsOnLayer( layer ) )
 zoneLayerCount++;
 }
 }
 
 PROGRESS_REPORTER* reporter = m_drcEngine->GetProgressReporter();
 
 if( reporter && reporter->IsCancelled() )
 return false; // DRC cancelled
 
 std::vector<SHAPE_POLY_SET> layerPolys( layerCount );
 
 auto build_layer_polys =
 [&]( int layerIdx ) -> size_t
 {
 PCB_LAYER_ID layer = copperLayers[layerIdx];
 SHAPE_POLY_SET& poly = layerPolys[layerIdx];
 
 if( m_drcEngine->IsCancelled() )
 return 0;
 
 SHAPE_POLY_SET fill;
 
 forEachGeometryItem( s_allBasicItems, LSET().set( layer ),
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( ZONE* zone = dynamic_cast<ZONE*>( item) )
 {
 if( !zone->GetIsRuleArea() )
 {
 fill = zone->GetFill( layer )->CloneDropTriangulation();
 fill.Unfracture( SHAPE_POLY_SET::PM_FAST );
 poly.Append( fill );
 
 // Report progress on board zones only. Everything else is
 // in the noise.
 done.fetch_add( 1 );
 }
 }
 else
 {
 item->TransformShapeToPolygon( poly, layer, 0, ARC_LOW_DEF,
 ERROR_OUTSIDE );
 }
 
 if( m_drcEngine->IsCancelled() )
 return false;
 
 return true;
 } );
 
 
 if( m_drcEngine->IsCancelled() )
 return 0;
 
 poly.Simplify( SHAPE_POLY_SET::PM_FAST );
 
 // Sharpen corners
 poly.Deflate( widthTolerance / 2, ARC_LOW_DEF,
 SHAPE_POLY_SET::ALLOW_ACUTE_CORNERS );
 
 return 1;
 };
 
 thread_pool& tp = GetKiCadThreadPool();
 std::vector<std::future<size_t>> returns;
 
 returns.reserve( copperLayers.size() );
 
 for( size_t ii = 0; ii < copperLayers.size(); ++ii )
 returns.emplace_back( tp.submit( build_layer_polys, ii ) );
 
 for( const std::future<size_t>& ret : returns )
 {
 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
 
 while( status != std::future_status::ready )
 {
 m_drcEngine->ReportProgress( static_cast<double>( zoneLayerCount ) / done );
 
 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
 }
 }
 
 
 for( int ii = 0; ii < layerCount; ++ii )
 {
 PCB_LAYER_ID layer = copperLayers[ii];
 SHAPE_POLY_SET& poly = layerPolys[ii];
 
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_COPPER_SLIVER ) )
 continue;
 
 // Frequently, in filled areas, some points of the polygons are very near (dist is only
 // a few internal units, like 2 or 3 units.
 // We skip very small vertices: one cannot really compute a valid orientation of
 // such a vertex
 // So skip points near than min_len (in internal units).
 const int min_len = pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_SliverMinimumLength );
 
 for( int jj = 0; jj < poly.OutlineCount(); ++jj )
 {
 const std::vector<VECTOR2I>& pts = poly.Outline( jj ).CPoints();
 int ptCount = pts.size();
 
 for( int kk = 0; kk < ptCount; ++kk )
 {
 VECTOR2I pt = pts[ kk ];
 VECTOR2I ptPrior = pts[ ( ptCount + kk - 1 ) % ptCount ];
 VECTOR2I vPrior = ( ptPrior - pt );
 
 if( std::abs( vPrior.x ) < min_len && std::abs( vPrior.y ) < min_len && ptCount > 5)
 {
 ptPrior = pts[ ( ptCount + kk - 2 ) % ptCount ];
 vPrior = ( ptPrior - pt );
 }
 
 VECTOR2I ptAfter = pts[ ( kk + 1 ) % ptCount ];
 VECTOR2I vAfter = ( ptAfter - pt );
 
 if( std::abs( vAfter.x ) < min_len && std::abs( vAfter.y ) < min_len && ptCount > 5 )
 {
 ptAfter = pts[ ( kk + 2 ) % ptCount ];
 vAfter = ( ptAfter - pt );
 }
 
 VECTOR2I vIncluded = vPrior.Resize( testLength ) - vAfter.Resize( testLength );
 
 if( vIncluded.SquaredEuclideanNorm() < SEG::Square( widthTolerance ) )
 {
 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_COPPER_SLIVER );
 drce->SetErrorMessage( drce->GetErrorText() + wxS( " " ) + layerDesc( layer ) );
 reportViolation( drce, pt, layer );
 }
 }
 }
 }
 
 return true;
}

References _, std::abs(), LSET::AllCuMask(), SHAPE_POLY_SET::ALLOW_ACUTE_CORNERS, ARC_LOW_DEF, SHAPE_LINE_CHAIN::CPoints(), DRC_ITEM::Create(), SHAPE_POLY_SET::Deflate(), DEG2RAD(), DRCE_COPPER_SLIVER, ERROR_OUTSIDE, DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_ENGINE::GetBoard(), ADVANCED_CFG::GetCfg(), BOARD::GetEnabledLayers(), GetKiCadThreadPool(), DRC_ENGINE::GetProgressReporter(), DRC_ENGINE::IsCancelled(), PROGRESS_REPORTER::IsCancelled(), DRC_ENGINE::IsErrorLimitExceeded(), layerDesc(), DRC_TEST_PROVIDER::m_drcEngine, ADVANCED_CFG::m_SliverAngleTolerance, EDA_IU_SCALE::mmToIU(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), pcbIUScale, SHAPE_POLY_SET::PM_FAST, DRC_TEST_PROVIDER::reportPhase(), DRC_ENGINE::ReportProgress(), DRC_TEST_PROVIDER::reportViolation(), VECTOR2< T >::Resize(), DRC_TEST_PROVIDER::s_allBasicItems, LSET::Seq(), SHAPE_POLY_SET::Simplify(), SEG::Square(), VECTOR2< T >::SquaredEuclideanNorm(), tp, BOARD_ITEM::TransformShapeToPolygon(), and BOARD::Zones().

RunTests()

bool DRC_TEST_PROVIDER::RunTests ( EDA_UNITS  aUnits )

inlineinherited

Definition at line 88 of file drc_test_provider.h.

 {
 SetUserUnits( aUnits );
 return Run();
 }

References DRC_TEST_PROVIDER::Run(), and UNITS_PROVIDER::SetUserUnits().

SetDRCEngine()

void DRC_TEST_PROVIDER::SetDRCEngine ( DRC_ENGINE *  engine )

inlineinherited

Definition at line 82 of file drc_test_provider.h.

 {
 m_drcEngine = engine;
 m_stats.clear();
 }

References DRC_TEST_PROVIDER::m_drcEngine, and DRC_TEST_PROVIDER::m_stats.

Referenced by DRC_INTERACTIVE_COURTYARD_CLEARANCE::DRC_INTERACTIVE_COURTYARD_CLEARANCE(), and DRC_ENGINE::RunTests().

SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS  aUnits )

inlineinherited

Definition at line 43 of file units_provider.h.

{ m_userUnits = aUnits; }

References UNITS_PROVIDER::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), DRC_ENGINE::RunTests(), and EDA_DRAW_FRAME::ToggleUserUnits().

StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue ( const EDA_ANGLE &  aValue, bool  aAddUnitLabel = false  )

inlineinherited

Definition at line 74 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue ( double  aValue, bool  aAddUnitLabel = false, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  )

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 67 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::StringFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PANEL_SETUP_BOARD_STACKUP::createRowData(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FP_TEXT_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

userUnits()

EDA_UNITS DRC_TEST_PROVIDER::userUnits ( ) const

protectedinherited

ValueFromString()

int UNITS_PROVIDER::ValueFromString ( const wxString &  aTextValue, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  )

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aTextValue

A reference to a wxString object containing the string to convert.

Returns

internal units value

Definition at line 108 of file units_provider.h.

 {
 double value = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), GetUserUnits(),
 aTextValue, aType );
 
 return KiROUND<double, int>( value );
 }

References EDA_UNIT_UTILS::UI::DoubleValueFromString(), UNITS_PROVIDER::GetIuScale(), and UNITS_PROVIDER::GetUserUnits().

Referenced by PIN_TABLE_DATA_MODEL::compare(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onCopperLayersSelCount(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortDiffPairsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortTrackWidthsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortViaSizesClick(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::Validate().

Member Data Documentation

m_drcEngine

DRC_ENGINE* DRC_TEST_PROVIDER::m_drcEngine

protectedinherited

Definition at line 128 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::layerDesc(), layerDesc(), DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportRuleStatistics(), DRC_TEST_PROVIDER::reportViolation(), DRC_CACHE_GENERATOR::Run(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER::SetDRCEngine(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

m_isRuleDriven

bool DRC_TEST_PROVIDER::m_isRuleDriven = true

protectedinherited

Definition at line 130 of file drc_test_provider.h.

Referenced by DRC_INTERACTIVE_COURTYARD_CLEARANCE::DRC_INTERACTIVE_COURTYARD_CLEARANCE(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::DRC_TEST_PROVIDER_COURTYARD_CLEARANCE(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::DRC_TEST_PROVIDER_FOOTPRINT_CHECKS(), DRC_TEST_PROVIDER_LIBRARY_PARITY::DRC_TEST_PROVIDER_LIBRARY_PARITY(), DRC_TEST_PROVIDER_MISC::DRC_TEST_PROVIDER_MISC(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::DRC_TEST_PROVIDER_SCHEMATIC_PARITY(), and DRC_TEST_PROVIDER::reportRuleStatistics().

m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 125 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

m_stats

std::unordered_map<const DRC_RULE*, int> DRC_TEST_PROVIDER::m_stats

protectedinherited

Definition at line 129 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::accountCheck(), DRC_TEST_PROVIDER::reportRuleStatistics(), and DRC_TEST_PROVIDER::SetDRCEngine().

m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 126 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetUserUnits(), and UNITS_PROVIDER::SetUserUnits().

s_allBasicItems

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItems

staticprotectedinherited

Definition at line 122 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_TEST_PROVIDER::Init(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), and DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance().

s_allBasicItemsButZones

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItemsButZones

staticprotectedinherited

Definition at line 123 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::Init(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges().

---

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

• drc_test_provider_sliver_checker.cpp