drc_re_rtg_diff_pair_panel.cpp

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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#include "drc_re_rtg_diff_pair_panel.h"
 
#include <wx/log.h>
 
 
DRC_RE_ROUTING_DIFF_PAIR_PANEL::DRC_RE_ROUTING_DIFF_PAIR_PANEL( wxWindow* aParent, wxString* aConstraintTitle,
        std::shared_ptr<DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA> aConstraintData ) :
        DRC_RE_ROUTING_DIFF_PAIR_PANEL_BASE( aParent ), m_constraintData( aConstraintData )
{
    bConstraintImageSizer->Add( GetConstraintImage( this, BITMAPS::constraint_routing_diff_pair ),
                                0,
                                wxALL | wxEXPAND, 10 );
}
 
 
DRC_RE_ROUTING_DIFF_PAIR_PANEL::~DRC_RE_ROUTING_DIFF_PAIR_PANEL()
{
}
 
 
bool DRC_RE_ROUTING_DIFF_PAIR_PANEL::TransferDataToWindow()
{
    if( m_constraintData )
    {
        m_maxUncoupledLengthTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetMaxUncoupledLength() ) );
 
        m_minWidthTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetMinWidth() ) );
        m_maxWidthTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetMaxWidth() ) );
        m_preferredWidthTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetPreferredWidth() ) );
 
        m_minGapTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetMinGap() ) );
        m_maxGapTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetMaxGap() ) );
        m_preferredGapTextCtrl->SetValue(
                wxString::Format( _( "%.2f" ), m_constraintData->GetPreferredGap() ) );
    }
 
    return true;
}
 
 
bool DRC_RE_ROUTING_DIFF_PAIR_PANEL::TransferDataFromWindow()
{
    m_constraintData->SetMaxUncoupledLength(
            std::stod( m_maxUncoupledLengthTextCtrl->GetValue().ToStdString() ) );
 
    m_constraintData->SetMinWidth( std::stod( m_minWidthTextCtrl->GetValue().ToStdString() ) );
    m_constraintData->SetMaxWidth( std::stod( m_maxWidthTextCtrl->GetValue().ToStdString() ) );
    m_constraintData->SetPreferredWidth(
            std::stod( m_preferredWidthTextCtrl->GetValue().ToStdString() ) );
 
    m_constraintData->SetMinGap( std::stod( m_minGapTextCtrl->GetValue().ToStdString() ) );
    m_constraintData->SetMaxGap( std::stod( m_maxGapTextCtrl->GetValue().ToStdString() ) );
    m_constraintData->SetPreferredGap(
            std::stod( m_preferredGapTextCtrl->GetValue().ToStdString() ) );
 
    return true;
}
 
 
bool DRC_RE_ROUTING_DIFF_PAIR_PANEL::ValidateInputs( int* aErrorCount,
                                                     std::string* aValidationMessage )
{
    TransferDataFromWindow();
    VALIDATION_RESULT result = m_constraintData->Validate();
 
    if( !result.isValid )
    {
        *aErrorCount = result.errors.size();
 
        for( size_t i = 0; i < result.errors.size(); i++ )
            *aValidationMessage += DRC_RULE_EDITOR_UTILS::FormatErrorMessage( i + 1, result.errors[i] );
 
        return false;
    }
 
    return true;
}
 
 
wxString DRC_RE_ROUTING_DIFF_PAIR_PANEL::GenerateRule( const RULE_GENERATION_CONTEXT& aContext )
{
    if( !m_constraintData )
        return wxEmptyString;
 
    auto formatDistance = [&]( double aValue )
    {
        return formatDouble( aValue ) + wxS( "mm" );
    };
 
    wxString widthClause = wxString::Format(
            wxS( "(constraint track_width (min %s) (opt %s) (max %s))" ),
            formatDistance( m_constraintData->GetMinWidth() ),
            formatDistance( m_constraintData->GetPreferredWidth() ),
            formatDistance( m_constraintData->GetMaxWidth() ) );
 
    wxString gapClause = wxString::Format(
            wxS( "(constraint diff_pair_gap (min %s) (opt %s) (max %s))" ),
            formatDistance( m_constraintData->GetMinGap() ),
            formatDistance( m_constraintData->GetPreferredGap() ),
            formatDistance( m_constraintData->GetMaxGap() ) );
 
    wxString uncoupledClause = wxString::Format(
            wxS( "(constraint diff_pair_uncoupled (max %s))" ),
            formatDistance( m_constraintData->GetMaxUncoupledLength() ) );
 
    wxLogTrace( wxS( "KI_TRACE_DRC_RULE_EDITOR" ), wxS( "Diff pair clauses: %s | %s | %s" ),
                widthClause, gapClause, uncoupledClause );
 
    return buildRule( aContext, { widthClause, gapClause, uncoupledClause } );
}