drc_re_via_style_constraint_data.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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 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/>.
 */
 
#ifndef DRC_RE_VIA_STYLE_CONSTRAINT_DATA_H_
#define DRC_RE_VIA_STYLE_CONSTRAINT_DATA_H_
 
#include "drc_re_base_constraint_data.h"
 
 
enum class VIA_STYLE_TYPE
{
    ANY = 0,
    THROUGH,
    MICRO,
    BLIND,
    BURIED
};
 
 
class DRC_RE_VIA_STYLE_CONSTRAINT_DATA : public DRC_RE_BASE_CONSTRAINT_DATA
{
public:
    DRC_RE_VIA_STYLE_CONSTRAINT_DATA() = default;
 
    explicit DRC_RE_VIA_STYLE_CONSTRAINT_DATA( const DRC_RE_BASE_CONSTRAINT_DATA& aBaseData ) :
            DRC_RE_BASE_CONSTRAINT_DATA( aBaseData )
    {
    }
 
    explicit DRC_RE_VIA_STYLE_CONSTRAINT_DATA( int aId, int aParentId, const wxString& aRuleName,
                                               double aMinViaDiameter, double aMaxViaDiameter,
                                               double aMinViaHoleSize, double aMaxViaHoleSize,
                                               VIA_STYLE_TYPE aViaType = VIA_STYLE_TYPE::ANY ) :
 
            DRC_RE_BASE_CONSTRAINT_DATA( aId, aParentId, aRuleName ),
            m_minViaDiameter( aMinViaDiameter ),
            m_maxViaDiameter( aMaxViaDiameter ),
            m_minViaHoleSize( aMinViaHoleSize ),
            m_maxViaHoleSize( aMaxViaHoleSize ),
            m_viaType( aViaType )
    {
    }
 
    virtual ~DRC_RE_VIA_STYLE_CONSTRAINT_DATA() = default;
 
    BITMAPS GetOverlayBitmap() const override { return BITMAPS::constraint_via_style; }
 
    std::vector<DRC_RE_FIELD_POSITION> GetFieldPositions() const override
    {
        // Positions measured from constraint_via_style.png bitmap
        // Format: { xStart, xEnd, yCenter }
        return {
            { 155, 210, 22, wxS( "mm" ), LABEL_POSITION::RIGHT,
              _( "Smallest allowed via diameter" ) }, // [0] min_via_diameter
            { 265, 320, 22, wxS( "mm" ), LABEL_POSITION::RIGHT, _( "Largest allowed via diameter" ),
              wxS( "–  " ) }, // [1] max_via_diameter
            { 195, 250, 202, wxS( "mm" ), LABEL_POSITION::RIGHT,
              _( "Smallest allowed via hole diameter" ) }, // [2] min_via_hole
            { 305, 360, 202, wxS( "mm" ), LABEL_POSITION::RIGHT, _( "Largest allowed via hole diameter" ),
              wxS( "–  " ) }, // [3] max_via_hole
            { 420, 525, 122, _( "Via type:" ), LABEL_POSITION::LEFT,
              _( "Restrict this rule to a single via type" ) }, // [4] via_type dropdown
        };
    }
 
    VALIDATION_RESULT Validate() const override
    {
        VALIDATION_RESULT result;
 
        bool hasDiameter = m_minViaDiameter != 0 || m_maxViaDiameter != 0;
        bool hasHoleSize = m_minViaHoleSize != 0 || m_maxViaHoleSize != 0;
 
        if( hasDiameter )
        {
            if( m_minViaDiameter <= 0 )
                result.AddError( _( "Minimum Via Diameter must be greater than 0" ) );
 
            if( m_maxViaDiameter <= 0 )
                result.AddError( _( "Maximum Via Diameter must be greater than 0" ) );
 
            if( m_minViaDiameter > 0 && m_maxViaDiameter > 0 && m_minViaDiameter > m_maxViaDiameter )
                result.AddError( _( "Minimum Via Diameter cannot be greater than Maximum Via Diameter" ) );
        }
 
        if( hasHoleSize )
        {
            if( m_minViaHoleSize <= 0 )
                result.AddError( _( "Minimum Via Hole Size must be greater than 0" ) );
 
            if( m_maxViaHoleSize <= 0 )
                result.AddError( _( "Maximum Via Hole Size must be greater than 0" ) );
 
            if( m_minViaHoleSize > 0 && m_maxViaHoleSize > 0 && m_minViaHoleSize > m_maxViaHoleSize )
                result.AddError( _( "Minimum Via Hole Size cannot be greater than Maximum Via Hole Size" ) );
        }
 
        if( !hasDiameter && !hasHoleSize )
            result.AddError( _( "At least one constraint must be specified" ) );
 
        return result;
    }
 
    std::vector<wxString> GetConstraintClauses( const RULE_GENERATION_CONTEXT& aContext ) const override
    {
        auto formatDimension = []( double aValue )
        {
            return formatDouble( aValue ) + wxS( "mm" );
        };
 
        std::vector<wxString> clauses;
 
        if( m_minViaDiameter > 0 && m_maxViaDiameter > 0 )
        {
            if( m_optViaDiameter >= m_minViaDiameter && m_optViaDiameter <= m_maxViaDiameter )
            {
                clauses.push_back( wxString::Format( wxS( "(constraint via_diameter (min %s) (opt %s) (max %s))" ),
                                                     formatDimension( m_minViaDiameter ),
                                                     formatDimension( m_optViaDiameter ),
                                                     formatDimension( m_maxViaDiameter ) ) );
            }
            else
            {
                clauses.push_back( wxString::Format( wxS( "(constraint via_diameter (min %s) (max %s))" ),
                                                     formatDimension( m_minViaDiameter ),
                                                     formatDimension( m_maxViaDiameter ) ) );
            }
        }
 
        if( m_minViaHoleSize > 0 && m_maxViaHoleSize > 0 )
        {
            if( m_optViaHoleSize >= m_minViaHoleSize && m_optViaHoleSize <= m_maxViaHoleSize )
            {
                clauses.push_back( wxString::Format(
                        wxS( "(constraint hole_size (min %s) (opt %s) (max %s))" ), formatDimension( m_minViaHoleSize ),
                        formatDimension( m_optViaHoleSize ), formatDimension( m_maxViaHoleSize ) ) );
            }
            else
            {
                clauses.push_back( wxString::Format( wxS( "(constraint hole_size (min %s) (max %s))" ),
                                                     formatDimension( m_minViaHoleSize ),
                                                     formatDimension( m_maxViaHoleSize ) ) );
            }
        }
 
        return clauses;
    }
 
    wxString GenerateRule( const RULE_GENERATION_CONTEXT& aContext ) override
    {
        RULE_GENERATION_CONTEXT ctx = aContext;
 
        wxString viaTypeCondition = GetViaTypeCondition();
 
        if( !viaTypeCondition.IsEmpty() )
        {
            if( ctx.conditionExpression.IsEmpty() )
                ctx.conditionExpression = viaTypeCondition;
            else
                ctx.conditionExpression = viaTypeCondition + wxS( " && " ) + ctx.conditionExpression;
        }
 
        return buildRule( ctx, GetConstraintClauses( ctx ) );
    }
 
    double GetMinViaDiameter() { return m_minViaDiameter; }
 
    void SetMinViaDiameter( double aMinViaDiameter ) { m_minViaDiameter = aMinViaDiameter; }
 
    double GetMaxViaDiameter() { return m_maxViaDiameter; }
 
    void SetMaxViaDiameter( double aMaxViaDiameter ) { m_maxViaDiameter = aMaxViaDiameter; }
 
    double GetMinViaHoleSize() { return m_minViaHoleSize; }
 
    void SetMinViaHoleSize( double aMinViaHoleSize ) { m_minViaHoleSize = aMinViaHoleSize; }
 
    double GetMaxViaHoleSize() { return m_maxViaHoleSize; }
 
    void SetMaxViaHoleSize( double aMaxViaHoleSize ) { m_maxViaHoleSize = aMaxViaHoleSize; }
 
    // The panel has no fields for the optimums, so a loaded rule's values are carried
    // through an edit unchanged.
    double GetOptViaDiameter() const { return m_optViaDiameter; }
 
    void SetOptViaDiameter( double aOptViaDiameter ) { m_optViaDiameter = aOptViaDiameter; }
 
    double GetOptViaHoleSize() const { return m_optViaHoleSize; }
 
    void SetOptViaHoleSize( double aOptViaHoleSize ) { m_optViaHoleSize = aOptViaHoleSize; }
 
    VIA_STYLE_TYPE GetViaType() const { return m_viaType; }
 
    void SetViaType( VIA_STYLE_TYPE aType ) { m_viaType = aType; }
 
    wxString GetViaTypeCondition() const
    {
        switch( m_viaType )
        {
        case VIA_STYLE_TYPE::THROUGH: return wxS( "A.Via_Type == 'Through'" );
        case VIA_STYLE_TYPE::MICRO: return wxS( "A.Via_Type == 'Micro'" );
        case VIA_STYLE_TYPE::BLIND: return wxS( "A.Via_Type == 'Blind'" );
        case VIA_STYLE_TYPE::BURIED: return wxS( "A.Via_Type == 'Buried'" );
        case VIA_STYLE_TYPE::ANY:
        default: return wxEmptyString;
        }
    }
 
    void CopyFrom( const ICopyable& aSource ) override
    {
        const auto& source = dynamic_cast<const DRC_RE_VIA_STYLE_CONSTRAINT_DATA&>( aSource );
 
        DRC_RE_BASE_CONSTRAINT_DATA::CopyFrom( source );
 
        m_minViaDiameter = source.m_minViaDiameter;
        m_maxViaDiameter = source.m_maxViaDiameter;
        m_minViaHoleSize = source.m_minViaHoleSize;
        m_maxViaHoleSize = source.m_maxViaHoleSize;
        m_optViaDiameter = source.m_optViaDiameter;
        m_optViaHoleSize = source.m_optViaHoleSize;
 
        m_viaType = source.m_viaType;
    }
 
private:
    double         m_minViaDiameter{ 0 };
    double         m_maxViaDiameter{ 0 };
    double         m_minViaHoleSize{ 0 };
    double         m_maxViaHoleSize{ 0 };
    double         m_optViaDiameter{ 0 };
    double         m_optViaHoleSize{ 0 };
    VIA_STYLE_TYPE m_viaType{ VIA_STYLE_TYPE::ANY };
};
 
#endif // DRC_RE_VIA_STYLE_CONSTRAINT_DATA_H_