kicad/pcbnew/board_connected_item.h

198 lines
5.8 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 1992-2021 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>
class NETCLASS;
class NETINFO_ITEM;
class PAD;
/**
* A base class derived from #BOARD_ITEM for items that can be connected and have a net, a
* netname, a clearance ...
*/
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:
return true;
default:
return false;
}
}
///< @copydoc BOARD_ITEM::IsConnected()
bool IsConnected() const override
{
return true;
}
/**
* Return #NET_INFO object for a given item.
*/
NETINFO_ITEM* GetNet() const
{
return m_netinfo;
}
/**
* Set a NET_INFO object for the item.
*/
void SetNet( NETINFO_ITEM* aNetInfo )
{
m_netinfo = aNetInfo;
}
/**
* @return the net code.
*/
int GetNetCode() const;
/**
* Set net using a net code.
*
* @note Pads not on copper layers will have their net code always set to 0 (not connected).
*
* @param aNetCode is a net code for the new net. It has to exist in #NETINFO_LIST held
* by #BOARD.
* @param aNoAssert if true, do not assert that the net exists. Otherwise, item is assigned
* to the unconnected net.
* @return true on success, false if the net did not exist
*/
bool SetNetCode( int aNetCode, bool aNoAssert );
void SetNetCode( int aNetCode )
{
SetNetCode( aNetCode, false );
}
/**
* @return the full netname.
*/
wxString GetNetname() const;
/**
* @return the full netname or "<no net>" in square braces, followed by "(Not Found)" if the
* netcode is undefined.
*/
wxString GetNetnameMsg() const;
/**
* @return the short netname.
*/
wxString GetShortNetname() const;
/**
* Return an item's "own" clearance in internal units.
*
* @param aLayer the layer in question.
* @param aSource [out] optionally reports the source as a user-readable string.
* @return the clearance in internal units.
*/
virtual int GetOwnClearance( PCB_LAYER_ID aLayer, wxString* aSource = nullptr ) const;
/**
* Return any local clearance overrides set in the "classic" (ie: pre-rule) system.
*
* @param aSource [out] optionally reports the source as a user-readable string.
* @return the clearance in internal units.
*/
virtual int GetLocalClearanceOverrides( wxString* aSource ) const { return 0; }
/**
* Return any local clearances set in the "classic" (ie: pre-rule) system. These are
* things like zone clearance which are **not** an override.
*
* @param aSource [out] optionally reports the source as a user readable string.
* @return the clearance in internal units.
*/
virtual int GetLocalClearance( wxString* aSource ) const { return 0; }
/**
* Return the #NETCLASS for this item.
*
* @note Do **not** return a std::shared_ptr from this. It is used heavily in DRC, and the
* std::shared_ptr stuff shows up large in performance profiling.
*/
virtual NETCLASS* GetNetClass() const;
/**
* Return the NETCLASS for this item, or the default netclass if none is defined.
*
* @note Do **not** return a std::shared_ptr from this. It is used heavily in DRC, and the
* std::shared_ptr stuff shows up large in performance profiling.
*/
virtual NETCLASS* GetEffectiveNetclass() const;
/**
* Returns the netclass of the zone.
*
* If the net is not found (can happen when a netlist is reread) and the net name does not
* exist, return the default net class (should not return a null pointer).
*
* @return the net class name of this item.
*/
virtual wxString GetNetClassName() const;
void SetLocalRatsnestVisible( bool aVisible )
{
m_localRatsnestVisible = aVisible;
}
bool GetLocalRatsnestVisible() const
{
return m_localRatsnestVisible;
}
protected:
/// Store all information about the net that item belongs to.
NETINFO_ITEM* m_netinfo;
private:
bool m_localRatsnestVisible;
};
#endif // BOARD_CONNECTED_ITEM_H