drc_test_provider_via_diameter.cpp

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.
 *
 * 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 2
 * 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/>.
 */
 
#include <pcb_track.h>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <drc/drc_test_provider.h>
 
/*
    Via diameter test.
 
    Errors generated:
    - DRCE_VIA_DIAMETER
*/
 
class DRC_TEST_PROVIDER_VIA_DIAMETER : public DRC_TEST_PROVIDER
{
public:
    DRC_TEST_PROVIDER_VIA_DIAMETER()
    {}
 
    virtual ~DRC_TEST_PROVIDER_VIA_DIAMETER() = default;
 
    virtual bool Run() override;
 
    virtual const wxString GetName() const override { return wxT( "diameter" ); };
};
 
 
bool DRC_TEST_PROVIDER_VIA_DIAMETER::Run()
{
    if( m_drcEngine->IsErrorLimitExceeded( DRCE_VIA_DIAMETER ) )
    {
        REPORT_AUX( wxT( "Via diameter violations ignored. Tests not run." ) );
        return true;        // continue with other tests
    }
 
    if( !m_drcEngine->HasRulesForConstraintType( VIA_DIAMETER_CONSTRAINT ) )
    {
        REPORT_AUX( wxT( "No via diameter constraints found. Tests not run." ) );
        return true;        // continue with other tests
    }
 
    if( !reportPhase( _( "Checking via diameters..." ) ) )
        return false;       // DRC cancelled
 
    auto checkViaDiameter =
            [&]( BOARD_ITEM* item ) -> bool
            {
                if( m_drcEngine->IsErrorLimitExceeded( DRCE_VIA_DIAMETER ) )
                    return false;
 
                if( item->Type() != PCB_VIA_T )
                    return true;
 
                PCB_VIA* via = static_cast<PCB_VIA*>( item );
 
                via->Padstack().ForEachUniqueLayer(
                        [&]( PCB_LAYER_ID aLayer )
                        {
                            if( via->IsGhostLayer( aLayer ) )
                                return;
 
                            DRC_CONSTRAINT constraint = m_drcEngine->EvalRules( VIA_DIAMETER_CONSTRAINT, item,
                                                                                nullptr, aLayer );
                            bool fail_min = false;
                            bool fail_max = false;
                            int  constraintDiameter = 0;
                            int  actual = via->GetWidth( aLayer );
 
                            auto layerDesc =
                                    [&]() -> wxString
                                    {
                                        if( aLayer == F_Cu )
                                            return m_drcEngine->GetBoard()->GetLayerName( F_Cu );
                                        else if( aLayer == B_Cu )
                                            return m_drcEngine->GetBoard()->GetLayerName( B_Cu );
                                        else if( via->Padstack().Mode() == PADSTACK::MODE::FRONT_INNER_BACK )
                                            return _( "Inner Layers" );
                                        else
                                            return m_drcEngine->GetBoard()->GetLayerName( aLayer );
                                    };
 
                            if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE )
                            {
                                if( constraint.Value().HasMin() && actual < constraint.Value().Min() )
                                {
                                    fail_min = true;
                                    constraintDiameter = constraint.Value().Min();
                                }
 
                                if( constraint.Value().HasMax() && actual > constraint.Value().Max() )
                                {
                                    fail_max = true;
                                    constraintDiameter = constraint.Value().Max();
                                }
                            }
 
                            if( fail_min || fail_max )
                            {
                                std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_VIA_DIAMETER );
                                wxString constraintName = constraint.GetName();
                                wxString msg;
 
                                if( fail_min )
                                {
                                    if( constraint.m_ImplicitMin )
                                        constraintName = _( "board setup constraints" );
 
                                    if( via->Padstack().Mode() == PADSTACK::MODE::NORMAL )
                                    {
                                        msg = formatMsg( _( "(%s min diameter %s; actual %s)" ),
                                                         constraintName,
                                                         constraintDiameter,
                                                         actual );
                                    }
                                    else
                                    {
                                        msg = formatMsg( _( "(%s min diameter %s; actual %s on %s)" ),
                                                         constraintName,
                                                         constraintDiameter,
                                                         actual,
                                                         layerDesc() );
                                    }
                                }
                                else if( fail_max )
                                {
                                    if( via->Padstack().Mode() == PADSTACK::MODE::NORMAL )
                                    {
                                        msg = formatMsg( _( "(%s max diameter %s; actual %s)" ),
                                                         constraintName,
                                                         constraintDiameter,
                                                         actual );
                                    }
                                    else
                                    {
                                        msg = formatMsg( _( "(%s max diameter %s; actual %s on %s)" ),
                                                         constraintName,
                                                         constraintDiameter,
                                                         actual,
                                                         layerDesc() );
                                    }
                                }
 
                                drcItem->SetErrorDetail( msg );
                                drcItem->SetItems( item );
                                drcItem->SetViolatingRule( constraint.GetParentRule() );
 
                                reportViolation( drcItem, via->GetPosition(), aLayer );
                            }
                        } );
 
                return true;
            };
 
    const int progressDelta = 500;
    int       ii = 0;
 
    for( PCB_TRACK* item : m_drcEngine->GetBoard()->Tracks() )
    {
        if( !reportProgress( ii++, m_drcEngine->GetBoard()->Tracks().size(), progressDelta ) )
            break;
 
        if( !checkViaDiameter( item ) )
            break;
    }
 
    return !m_drcEngine->IsCancelled();
}
 
 
namespace detail
{
static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_VIA_DIAMETER> dummy;
}