board_connected_item.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 1992-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
 */
 
#ifndef BOARD_CONNECTED_ITEM_H
#define BOARD_CONNECTED_ITEM_H
 
#include <board_item.h>
#include <teardrop/teardrop_parameters.h>
 
class NETCLASS;
class NETINFO_ITEM;
class PAD;
 
class BOARD_CONNECTED_ITEM : public BOARD_ITEM
{
public:
    BOARD_CONNECTED_ITEM( BOARD_ITEM* aParent, KICAD_T idtype );
 
    // Do not create a copy constructor & operator=.
    // The ones generated by the compiler are adequate.
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        if( aItem == nullptr )
            return false;
 
        switch( aItem->Type() )
        {
        case PCB_PAD_T:
        case PCB_TRACE_T:
        case PCB_ARC_T:
        case PCB_VIA_T:
        case PCB_ZONE_T:
        case PCB_SHAPE_T:
            return true;
 
        default:
            return false;
        }
    }
 
    bool IsConnected() const override
    {
        return true;
    }
 
    NETINFO_ITEM* GetNet() const
    {
        return m_netinfo;
    }
 
    void SetNet( NETINFO_ITEM* aNetInfo )
    {
        m_netinfo = aNetInfo;
    }
 
    int GetNetCode() const;
 
    bool SetNetCode( int aNetCode, bool aNoAssert );
 
    void SetNetCode( int aNetCode )
    {
        SetNetCode( aNetCode, false );
    }
 
    wxString GetNetname() const;
 
    wxString GetNetnameMsg() const;
 
    const wxString& GetShortNetname() const;
 
    const wxString& GetDisplayNetname() const;
 
    virtual int GetOwnClearance( PCB_LAYER_ID aLayer, wxString* aSource = nullptr ) const;
 
    virtual std::optional<int> GetClearanceOverrides( wxString* aSource ) const
    {
        return std::optional<int>();
    }
 
    virtual std::optional<int> GetLocalClearance() const
    {
        return std::optional<int>();
    }
 
    virtual std::optional<int> GetLocalClearance( wxString* aSource ) const
    {
        return std::optional<int>();
    }
 
    virtual NETCLASS* GetEffectiveNetClass() const;
 
    wxString GetNetClassName() const;
 
    /*
     * Returns the name of the effective netclass for variable substitutions
     */
    wxString GetNetClassVariableSubstitutionName() const;
 
    void SetLocalRatsnestVisible( bool aVisible ) { m_localRatsnestVisible = aVisible; }
    bool GetLocalRatsnestVisible() const { return m_localRatsnestVisible; }
 
    TEARDROP_PARAMETERS& GetTeardropParams() { return m_teardropParams; }
    const TEARDROP_PARAMETERS& GetTeardropParams() const { return m_teardropParams; }
 
    void SetTeardropsEnabled( bool aEnable ) { m_teardropParams.m_Enabled = aEnable; }
    bool GetTeardropsEnabled() const { return m_teardropParams.m_Enabled; }
 
    void SetTeardropBestLengthRatio( double aRatio ) { m_teardropParams.m_BestLengthRatio = aRatio; }
    double GetTeardropBestLengthRatio() const { return m_teardropParams.m_BestLengthRatio; }
 
    void SetTeardropMaxLength( int aMaxLength ) { m_teardropParams.m_TdMaxLen = aMaxLength; }
    int GetTeardropMaxLength() const { return m_teardropParams.m_TdMaxLen; }
 
    void SetTeardropBestWidthRatio( double aRatio ) { m_teardropParams.m_BestWidthRatio = aRatio; }
    double GetTeardropBestWidthRatio() const { return m_teardropParams.m_BestWidthRatio; }
 
    void SetTeardropMaxWidth( int aMaxWidth ) { m_teardropParams.m_TdMaxWidth = aMaxWidth; }
    int GetTeardropMaxWidth() const { return m_teardropParams.m_TdMaxWidth; }
 
    void SetTeardropCurved( bool aCurve ) { m_teardropParams.m_CurveSegCount = aCurve ? 1 : 0; }
    bool GetTeardropCurved() const { return m_teardropParams.m_CurveSegCount > 0; }
 
    void SetTeardropPreferZoneConnections( bool aPrefer ) { m_teardropParams.m_TdOnPadsInZones = !aPrefer; }
    bool GetTeardropPreferZoneConnections() const { return !m_teardropParams.m_TdOnPadsInZones; }
 
    void SetTeardropAllowSpanTwoTracks( bool aAllow ) { m_teardropParams.m_AllowUseTwoTracks = aAllow; }
    bool GetTeardropAllowSpanTwoTracks() const { return m_teardropParams.m_AllowUseTwoTracks; }
 
    void SetTeardropMaxTrackWidth( double aRatio ) { m_teardropParams.m_WidthtoSizeFilterRatio = aRatio; }
    double GetTeardropMaxTrackWidth() const { return m_teardropParams.m_WidthtoSizeFilterRatio; }
 
protected:
    NETINFO_ITEM* m_netinfo;
 
    TEARDROP_PARAMETERS m_teardropParams;
 
private:
    bool m_localRatsnestVisible;
 
};
 
#endif  // BOARD_CONNECTED_ITEM_H